types

# Class: baseType

Source Location: /lib/baseType.inc

### Class Overview

This is the parent class of all account types.

### Methods

- getAlias
- getDefaultListAttributes
- getDescription
- getListAttributeDescriptions
- getListClassName

### Child classes:

mailAlias
  The account type for mail aliases.

host
  The account type for host accounts (e.g. Samba).

smbDomain
  The account type for Samba domains.

group
  The account type for group accounts (e.g. Unix and Samba).

user
  The account type for user accounts (e.g. Unix, Samba and Kolab).

### Class Details

[line 36]
This is the parent class of all account types.
[ Top ]

### Class Methods

### method getAlias [line 44]

`string getAlias( )`

Returns the alias name of this account type.

This function must be overwritten by the child classes.

#### Tags:

return: | alias name

Overridden in child classes as:

mailAlias::getAlias()
  Returns the alias name of this account type.

host::getAlias()
  Returns the alias name of this account type.

smbDomain::getAlias()
  Returns the alias name of this account type.

group::getAlias()
  Returns the alias name of this account type.

user::getAlias()
  Returns the alias name of this account type.

[ Top ]

### method getDefaultListAttributes [line 73]

`string getDefaultListAttributes( )`

Returns the default attribute list for this account type.

This function must be overwritten by the child classes.

#### Tags:

return: | attribute list

Overridden in child classes as:

mailAlias::getDefaultListAttributes()
  Returns the default attribute list for this account type.

host::getDefaultListAttributes()
  Returns the default attribute list for this account type.

smbDomain::getDefaultListAttributes()
  Returns the default attribute list for this account type.

group::getDefaultListAttributes()
  Returns the default attribute list for this account type.

user::getDefaultListAttributes()
  Returns the default attribute list for this account type.

[ Top ]

### method getDescription [line 54]

`string getDescription( )`

Returns the description of this account type.

This function must be overwritten by the child classes.

#### Tags:

return: | description

Overridden in child classes as:

mailAlias::getDescription()
  Returns the description of this account type.

host::getDescription()
  Returns the description of this account type.

smbDomain::getDescription()
  Returns the description of this account type.

group::getDescription()
  Returns the description of this account type.

user::getDescription()
  Returns the description of this account type.

[ Top ]

### method getListAttributeDescriptions [line 83]

`array getListAttributeDescriptions( )`

Returns a list of attributes which have a translated description.

This is used for the head row in the list view.

#### Tags:

return: | list of descriptions

Overridden in child classes as:

mailAlias::getListAttributeDescriptions()
  Returns a list of attributes which have a translated description.

host::getListAttributeDescriptions()
  Returns a list of attributes which have a translated description.

smbDomain::getListAttributeDescriptions()
  Returns a list of attributes which have a translated description.

group::getListAttributeDescriptions()
  Returns a list of attributes which have a translated description.

user::getListAttributeDescriptions()
  Returns a list of attributes which have a translated description.

[ Top ]

### method getListClassName [line 63]

`string getListClassName( )`

Returns the class name for the list object.

#### Tags:

return: | class name

Overridden in child classes as:

mailAlias::getListClassName()
  Returns the class name for the list object.

host::getListClassName()
  Returns the class name for the list object.

smbDomain::getListClassName()
  Returns the class name for the list object.

group::getListClassName()
  Returns the class name for the list object.

user::getListClassName()
  Returns the class name for the list object.

[ Top ]

Documentation generated on Mon, 28 Apr 2008 20:16:59 +0200 by phpDocumentor 1.4.0