lib/modules/kolabGroup.inc

Properties

Description

Manages Kolab group accounts.

Classes

kolabGroup

Properties

 
 
modules  
No 
No 

Description

Manages Kolab group accounts.
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 ".inc". E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc". The class name of a module must contain only a-z, A-Z, 0-9, -, and _.

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, loadMailCache, loadMailHostCache, load_Messages, load_profile, manageMail, process_attributes, process_deleteFlag, save_attributes,

__construct( string   $scope, ) : n/a

Description

Creates a new kolabGroup 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 class

Return value

Type Description
array array with meta data

Tags

Name Description
see

get_pdfEntries( ) : n/a

Description

Returns a list of PDF entries

Return value

Type Description
n/a n/a

loadMailCache( ) : n/a

Description

Loads the list of email addresses into the cache.

Return 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

load_profile( array   $profile, ) : n/a

Description

Loads the values of an account profile into internal variables.

Arguments

Name Type Description Default
$profile array

hash array with profile values (identifier => value)

Return value

Type Description
n/a n/a

manageMail( ) : boolean

Description

Returns if the mail attribute should be managed.

Return value

Type Description
boolean manage mail attribute

process_attributes( ) : array

Description

Processes user input of the primary module page.
It checks if all input values are correct and updates the associated LDAP attributes.

Return value

Type Description
array list of info/error messages

process_deleteFlag( ) : n/a

Description

Write variables into object and do some regex checks

Return value

Type Description
n/a n/a

save_attributes( ) : array

Description

Returns a list of modifications which have to be made to the LDAP account.

Return value

Type Description
array list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)

Properties

$mailCache, $mailHostCache,

  private  $mailCache = null

cache for mail attribute


  private  $mailHostCache = null

cache for mailHost values


Documentation was generated by phpDocumentor 2.1.0 .

Namespaces

  • global

    Packages