lib/baseType.inc
Properties
author
package
Description This is the parent class of all account types.
Classes
baseType
Properties
Extends
Implements
package
Abstract No
Final No
Description
This is the parent class of all account types.
Methods
__construct ,
getAlias ,
getDefaultListAttributes ,
getDescription ,
getListAttributeDescriptions ,
getListClassName ,
getSuffixList ,
getTitleBarSubtitle ,
getTitleBarTitle ,
runEditPagePostAction ,
supportsFileUpload ,
__construct(
)
:
n/a
Description
Creates a new type object. Return value
getAlias(
)
:
string
Description
Returns the alias name of this account type. This function must be overwritten by the child classes. Return value
Type
Description
string
alias name
getDefaultListAttributes(
)
:
string
Description
Returns the default attribute list for this account type. This function must be overwritten by the child classes. Return value
Type
Description
string
attribute list
getDescription(
)
:
string
Description
Returns the description of this account type. This function must be overwritten by the child classes. Return value
Type
Description
string
description
getListAttributeDescriptions(
)
:
array
Description
Returns a list of attributes which have a translated description. This is used for the head row in the list view. Return value
Type
Description
array
list of descriptions
getListClassName(
)
:
string
Description
Returns the class name for the list object. Return value
Type
Description
string
class name
getSuffixList(
)
:
array
Description
Returns a list of LDAP suffixes for this type. Return value
Type
Description
array
sorted list of possible suffixes for this type.
getTitleBarSubtitle(
\accountContainer
$container,
)
:
String
Description
Returns the the title text for the title bar on the new/edit page. Arguments
Return value
Type
Description
String
title text
getTitleBarTitle(
\accountContainer
$container,
)
:
String
Description
Returns the the title text for the title bar on the new/edit page. Arguments
Return value
Type
Description
String
title text
runEditPagePostAction(
\accountContainer
$container,
)
:
n/a
Description
This function is called after the edit page is processed and before the page content is generated. This can be used to run custom handlers after each page processing. Arguments
Return value
supportsFileUpload(
)
:
boolean
Description
Returns if entries of this type may be created via file upload. Return value
Type
Description
boolean
true, if file upload is supported