types

# Class: baseType

Source Location: /lib/baseType.inc

### Class Overview

This is the parent class of all account types.

### Variables

- $LABEL_BACK_TO_ACCOUNT_LIST
- $LABEL_CREATE_ANOTHER_ACCOUNT

### Methods

- __construct
- getAlias
- getDefaultListAttributes
- getDescription
- getListAttributeDescriptions
- getListClassName
- getSuffixList
- getTitleBarSubtitle
- getTitleBarTitle
- supportsFileUpload

### Child classes:

asteriskExt
  The account type for Asterisk extensions.

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).

dhcp
  The account type for DHCP

netgroup
  The account type for NIS netgroups.

### Class Details

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

### Class Variables

#### $LABEL_BACK_TO_ACCOUNT_LIST =

[line 39]

#### Tags:

access: | public

Type: | mixed

[ Top ]

#### $LABEL_CREATE_ANOTHER_ACCOUNT =

[line 38]

#### Tags:

access: | public

Type: | mixed

[ Top ]

### Class Methods

### constructor __construct [line 44]

`baseType __construct( )`

Creates a new type object.

#### Tags:

access: | public

Overridden in child classes as:

asteriskExt::__construct()
  Constructs a new domain type object.

mailAlias::__construct()
  Constructs a new alias type object.

host::__construct()
  Constructs a new host type object.

smbDomain::__construct()
  Constructs a new domain type object.

group::__construct()
  Constructs a new group type object.

user::__construct()
  Constructs a new user type object.

dhcp::__construct()
  Constructs a new DHCP type object.

netgroup::__construct()
  Constructs a new group type object.

[ Top ]

### method getAlias [line 55]

`string getAlias( )`

Returns the alias name of this account type.

This function must be overwritten by the child classes.

#### Tags:

return: | alias name
access: | public

Overridden in child classes as:

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

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.

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

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

[ Top ]

### method getDefaultListAttributes [line 84]

`string getDefaultListAttributes( )`

Returns the default attribute list for this account type.

This function must be overwritten by the child classes.

#### Tags:

return: | attribute list
access: | public

Overridden in child classes as:

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

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.

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

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

[ Top ]

### method getDescription [line 65]

`string getDescription( )`

Returns the description of this account type.

This function must be overwritten by the child classes.

#### Tags:

return: | description
access: | public

Overridden in child classes as:

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

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.

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

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

[ Top ]

### method getListAttributeDescriptions [line 94]

`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
access: | public

Overridden in child classes as:

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

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.

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

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

[ Top ]

### method getListClassName [line 74]

`string getListClassName( )`

Returns the class name for the list object.

#### Tags:

return: | class name
access: | public

Overridden in child classes as:

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

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.

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

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

[ Top ]

### method getSuffixList [line 138]

`array getSuffixList( )`

Returns a list of LDAP suffixes for this type.

#### Tags:

return: | sorted list of possible suffixes for this type.
access: | public

[ Top ]

### method getTitleBarSubtitle [line 129]

`String getTitleBarSubtitle( array $attributes)`

Returns the the title text for the title bar on the new/edit page.

#### Tags:

return: | title text
access: | public

Overridden in child classes as:

host::getTitleBarSubtitle()
  Returns the the title text for the title bar on the new/edit page.

smbDomain::getTitleBarSubtitle()
  Returns the the title text for the title bar on the new/edit page.

group::getTitleBarSubtitle()
  Returns the the title text for the title bar on the new/edit page.

user::getTitleBarSubtitle()
  Returns the the title text for the title bar on the new/edit page.

dhcp::getTitleBarSubtitle()
  Returns the the title text for the title bar on the new/edit page.

netgroup::getTitleBarSubtitle()
  Returns the the title text for the title bar on the new/edit page.

#### Parameters:

array | $attributes | list of LDAP attributes for the displayed account (null, if new account)

[ Top ]

### method getTitleBarTitle [line 113]

`String getTitleBarTitle( array $attributes)`

Returns the the title text for the title bar on the new/edit page.

#### Tags:

return: | title text
access: | public

Overridden in child classes as:

asteriskExt::getTitleBarTitle()
  Returns the the title text for the title bar on the new/edit page.

mailAlias::getTitleBarTitle()
  Returns the the title text for the title bar on the new/edit page.

host::getTitleBarTitle()
  Returns the the title text for the title bar on the new/edit page.

smbDomain::getTitleBarTitle()
  Returns the the title text for the title bar on the new/edit page.

group::getTitleBarTitle()
  Returns the the title text for the title bar on the new/edit page.

user::getTitleBarTitle()
  Returns the the title text for the title bar on the new/edit page.

dhcp::getTitleBarTitle()
  Returns the the title text for the title bar on the new/edit page.

netgroup::getTitleBarTitle()
  Returns the the title text for the title bar on the new/edit page.

#### Parameters:

array | $attributes | list of LDAP attributes for the displayed account (null, if new account)

[ Top ]

### method supportsFileUpload [line 103]

`boolean supportsFileUpload( )`

Returns if entries of this type may be created via file upload.

#### Tags:

return: | true, if file upload is supported
access: | public

[ Top ]

Documentation generated on Tue, 22 Nov 2011 16:29:32 +0100 by phpDocumentor 1.4.1