Class: inetOrgPerson
Source Location: /lib/modules/inetOrgPerson.inc
baseModule
|
--inetOrgPerson
This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).
Author(s):
Implements interfaces:
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Methods
method build_uploadAccounts [line 1264]
array build_uploadAccounts(
array
$rawAccounts, array
$ids,
&$partialAccounts, array
$selectedModules, array
$partialAccounts)
|
|
In this function the LDAP account is built up.
Tags:
Overrides baseModule::build_uploadAccounts() (In this function the LDAP accounts are built.)
Parameters:
method checkSelfServiceOptions [line 1686]
array checkSelfServiceOptions(
string
$fields, array
$attributes)
|
|
Checks if all input values are correct and returns the LDAP attributes which should be changed. Return values: messages: array of parameters to create status messages add: array of attributes to add del: array of attributes to remove mod: array of attributes to modify info: array of values with informational value (e.g. to be used later by pre/postModify actions)
Calling this method does not require the existence of an enclosing accountContainer.
Tags:
Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP attributes which should be changed.)
Parameters:
method display_html_attributes [line 878]
array display_html_attributes(
)
|
|
Returns the HTML meta data for the main account page.
Tags:
Overrides baseModule::display_html_attributes() (This function creates meta HTML code to display the module page.)
method display_html_photo [line 1069]
array display_html_photo(
)
|
|
Displays the photo upload page.
Tags:
method getButtonStatus [line 685]
string getButtonStatus(
)
|
|
Controls if the module button the account page is visible and activated.
Tags:
Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)
method getSelfServiceOptions [line 1515]
array getSelfServiceOptions(
array
$fields, array
$attributes)
|
|
Returns the meta HTML code for each input field. format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.
Tags:
Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)
Parameters:
method get_metaData [line 89]
Returns meta data that is interpreted by parent class
Tags:
Overrides baseModule::get_metaData() (This function provides meta data which is interpreted by baseModule.)
method get_pdfEntries [line 1084]
method get_uploadColumns [line 1232]
array get_uploadColumns(
array
$selectedModules)
|
|
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: <module name>_<column name>) 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 )
Tags:
Overrides baseModule::get_uploadColumns() (Returns an array containing all input columns for the file upload.)
Parameters:
method load_Messages [line 46]
This function fills the message array.
Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)
method load_profile [line 1204]
void load_profile(
array
$profile)
|
|
Loads the values of an account profile into internal variables.
Overrides baseModule::load_profile() (This function loads the values from an account profile to the module's internal data structures.)
Parameters:
method managesPasswordAttributes [line 1907]
boolean managesPasswordAttributes(
)
|
|
This method specifies if a module manages password attributes.
Tags:
Implementation of:
- passwordService::managesPasswordAttributes()
- This method specifies if a module manages password attributes. The module alias will then appear as option in the GUI.
method module_complete [line 662]
boolean module_complete(
)
|
|
This functions return true if all needed settings are done.
Tags:
Overrides baseModule::module_complete() (This function is used to check if all settings for this module have been made.)
method passwordChangeRequested [line 1925]
array passwordChangeRequested(
String
$password, $modules
$modules)
|
|
This function is called whenever the password should be changed. Account modules must change their password attributes only if the modules list contains their module name.
Tags:
Implementation of:
- passwordService::passwordChangeRequested()
- This function is called whenever the password should be changed. Account modules must change their password attributes only if the modules list contains their module name.
Parameters:
method process_attributes [line 736]
array process_attributes(
)
|
|
Processes user input of the primary module page. It checks if all input values are correct and updates the associated LDAP attributes.
Tags:
Overrides baseModule::process_attributes() (This function processes user input.)
method process_photo [line 1049]
method save_attributes [line 708]
Returns a list of modifications which have to be made to the LDAP account.
Tags:
Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)
|
|