LDAP Account Manager

kolabSharedFolderType extends baseType
in package

The account type for Kolab shared folders.

Table of Contents

$LABEL_BACK_TO_ACCOUNT_LIST  : mixed
label to return to account list
$LABEL_CREATE_ANOTHER_ACCOUNT  : mixed
label to create another account
$type  : mixed
type configuration
__construct()  : mixed
Constructs a new shared folder object.
buildAccountStatusIcon()  : htmlElement|null
Builds the HTML code for the icon that shows the account status (locked/unlocked).
check_configOptions()  : array<string|int, mixed>
Checks input values of config settings.
get_configOptions()  : mixed
Returns a list of configuration options.
getAlias()  : string
Returns the alias name of this account type.
getDefaultListAttributes()  : string
Returns the default attribute list for this account type.
getDescription()  : string
Returns the description of this account type.
getIcon()  : string
Returns the file name of the type icon.
getListAttributeDescriptions()  : array<string|int, mixed>
Returns a list of attributes which have a translated description.
getListClassName()  : string
Returns the class name for the list object.
getScope()  : string
Returns the scope name.
getSuffixFilter()  : string
Returns the LDAP filter to find the possible suffixes for this account type.
getTitleBarSubtitle()  : string
Returns the the title text for the title bar on the new/edit page.
getTitleBarTitle()  : string
Returns the the title text for the title bar on the new/edit page.
runEditPagePostAction()  : void
This function is called after the edit page is processed and before the page content is generated.
supportsFileUpload()  : bool
Returns if entries of this type may be created via file upload.
supportsMultipleConfigs()  : bool
Returns if this account type supports multiple configurations.
getType()  : ConfiguredType
Returns the type configuration.
buildAccountStatusDialogDiv()  : htmlElement
Builds the dialog to (un)lock parts of an account.

Properties

$LABEL_BACK_TO_ACCOUNT_LIST

label to return to account list

public mixed $LABEL_BACK_TO_ACCOUNT_LIST

$LABEL_CREATE_ANOTHER_ACCOUNT

label to create another account

public mixed $LABEL_CREATE_ANOTHER_ACCOUNT

$type

type configuration

private mixed $type

Methods

__construct()

Constructs a new shared folder object.

public __construct(ConfiguredType $type) : mixed
Parameters
$type : ConfiguredType

configuration

Return values
mixed —

check_configOptions()

Checks input values of config settings.

public check_configOptions(array<string|int, mixed> &$options) : array<string|int, mixed>

If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text').
If no errors occurred the function returns an empty array.
Parameters
$options : array<string|int, mixed>

hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.

Return values
array<string|int, mixed> —

list of error messages

get_configOptions()

Returns a list of configuration options.

public get_configOptions() : mixed

The field names are used as keywords to load and save settings. We recommend to use the type name as prefix for them (e.g. user_someSetting) to avoid naming conflicts.

Tags
see
htmlElement
Return values
mixed —

htmlElement or array of htmlElement

getAlias()

Returns the alias name of this account type.

public getAlias() : string
Return values
string —

alias name

getDefaultListAttributes()

Returns the default attribute list for this account type.

public getDefaultListAttributes() : string
Return values
string —

attribute list

getDescription()

Returns the description of this account type.

public getDescription() : string
Return values
string —

description

getIcon()

Returns the file name of the type icon.

public getIcon() : string

It needs to be 16x16px and located in graphics folder. By default this is "{type name}.png"

Return values
string —

file name

getListAttributeDescriptions()

Returns a list of attributes which have a translated description.

public getListAttributeDescriptions() : array<string|int, mixed>

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

Return values
array<string|int, mixed> —

list of descriptions

getListClassName()

Returns the class name for the list object.

public getListClassName() : string
Return values
string —

class name

getScope()

Returns the scope name.

public getScope() : string
Return values
string —

scope

getSuffixFilter()

Returns the LDAP filter to find the possible suffixes for this account type.

public getSuffixFilter() : string
Return values
string —

LDAP filter

getTitleBarSubtitle()

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

public getTitleBarSubtitle(accountContainer $container) : string
Parameters
$container : accountContainer

account container

Return values
string —

title text

runEditPagePostAction()

This function is called after the edit page is processed and before the page content is generated.

public runEditPagePostAction(accountContainer $container) : void

This can be used to run custom handlers after each page processing.

Parameters
$container : accountContainer

account container

Return values
void —

supportsFileUpload()

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

public supportsFileUpload() : bool
Return values
bool —

true, if file upload is supported

supportsMultipleConfigs()

Returns if this account type supports multiple configurations.

public supportsMultipleConfigs() : bool
Return values
bool —

multiple configs supported

getType()

Returns the type configuration.

protected getType() : ConfiguredType
Return values
ConfiguredType —

type configuration

Search results