lib/modules/account.inc
Properties
Description
Manages the object class "account" for users and hosts.Classes
account
Description
Manages the object class "account" for users and hosts.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
build_uploadAccounts, display_html_attributes, getButtonStatus, get_metaData, get_pdfEntries, get_uploadColumns, load_Messages, module_complete, process_attributes, save_attributes,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 |
getButtonStatus( ) : string
Description
Controls if the module button the account page is visible and activated.Return value
Type | Description |
---|---|
string | status ("enabled", "disabled", "hidden") |
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( ) : array
Description
Returns the PDF entries for this module.Return value
Type | Description |
---|---|
array | list of possible PDF entries |
get_uploadColumns( array $selectedModules, ) : array
Description
Returns an array containing all input columns for the file upload.Syntax:
array(
string: name, // fixed non-translated name which is used as column name (should be of format:
string: description, // short descriptive name
string: help, // help ID
string: example, // example value
boolean: required // true, if user must set a value for this column
)
Arguments
Name | Type | Description | Default |
---|---|---|---|
$selectedModules | array | list of selected account modules |
Return value
Type | Description |
---|---|
array | column list |
load_Messages( ) : n/a
Description
This function fills the message array.Return value
Type | Description |
---|---|
n/a | n/a |
module_complete( ) : boolean
Description
This functions returns true if all needed settings are done.Return value
Type | Description |
---|---|
boolean | true if LDAP operation can be done |
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 |
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) |