lib/modules/kolabSharedFolder.inc
Classes |
Properties
Description
Manages Kolab shared folders.Classes
kolabSharedFolder
Description
Manages Kolab shared folders.It implements the complete module interface and uses meta-data provided by the account modules for its functions.
Location and naming of modules
All LAM modules are placed in lib/modules/ and are named "
You can avoid to override many functions by using {@link get_metaData()}.
All module classes should extend the baseModule class.
Methods
__construct, build_uploadAccounts, display_html_attributes, display_html_deleteFlag, get_metaData, get_pdfEntries, loadMailHostCache, load_Messages, process_attributes, process_deleteFlag,__construct( string $scope, ) : n/a
Description
Creates a new kolabSharedFolder object.Arguments
Name | Type | Description | Default |
---|---|---|---|
$scope | string | account type (user, group, host) |
Return value
Type | Description |
---|---|
n/a | n/a |
build_uploadAccounts( array $rawAccounts, array $ids, array $partialAccounts, array $selectedModules, ) : array
Description
In this function the LDAP account is built up.Arguments
Name | Type | Description | Default |
---|---|---|---|
$rawAccounts | array | list of hash arrays (name => value) from user input |
|
$ids | array | list of IDs for column position (e.g. "posixAccount_uid" => 5) |
|
$partialAccounts | array | list of hash arrays (name => value) which are later added to LDAP |
|
$selectedModules | array | list of selected account modules |
Return value
Type | Description |
---|---|
array | list of error messages if any |
display_html_attributes( ) : \htmlElement
Description
Returns the HTML meta data for the main account page.Return value
Type | Description |
---|---|
\htmlElement | HTML meta data |
display_html_deleteFlag( ) : \htmlElement
Description
This function will create the meta HTML code to show a page to mark an account for deletion.Return value
Type | Description |
---|---|
\htmlElement | HTML meta data |
get_metaData( ) : array
Description
Returns meta data that is interpreted by parent classReturn value
Type | Description |
---|---|
array | array with meta data |
Tags
Name | Description |
---|---|
see |
get_pdfEntries( ) : n/a
Description
Returns a list of PDF entriesReturn value
Type | Description |
---|---|
n/a | n/a |
loadMailHostCache( ) : n/a
Description
Loads the list of mail hosts into the cache.Return value
Type | Description |
---|---|
n/a | n/a |
load_Messages( ) : n/a
Description
This function fills the $messages variable with output messages from this module.Return value
Type | Description |
---|---|
n/a | n/a |