lib/types.inc
Properties
Description
This file is the interface to the different account types.
Functions
getTypes(
)
:
array
Description
Returns a list of available account types.Return value
| Type |
Description |
| array |
list of types |
getTypeAlias(
string
$type,
)
:
string
Description
Returns the alias name of an account type.Arguments
| Name |
Type |
Description |
Default |
| $type |
string |
type name |
|
Return value
| Type |
Description |
| string |
type alias |
getTypeDescription(
string
$type,
)
:
string
Description
Returns the description of an account type.Arguments
| Name |
Type |
Description |
Default |
| $type |
string |
type name |
|
Return value
| Type |
Description |
| string |
type description |
getListClassName(
string
$type,
)
:
string
Description
Returns the class name for the list object.Arguments
| Name |
Type |
Description |
Default |
| $type |
string |
account type |
|
Return value
| Type |
Description |
| string |
class name |
getDefaultListAttributes(
string
$type,
)
:
string
Description
Returns the default attribute list for an account type.It is used as default value for the configuration editor.Arguments
| Name |
Type |
Description |
Default |
| $type |
string |
account type |
|
Return value
| Type |
Description |
| string |
attribute list |
getListAttributeDescriptions(
string
$type,
)
:
array
Description
Returns a list of attributes which have a translated description.This is used for the head row in the list view.Arguments
| Name |
Type |
Description |
Default |
| $type |
string |
account type |
|
Return value
| Type |
Description |
| array |
list of descriptions |