constructor baseModule [line 71]
baseModule baseModule(
string
$scope)
|
|
Creates a new base module class
Parameters:
method build_uploadAccounts [line 495]
method can_manage [line 160]
Returns true if this module fits for the current scope.
Tags:
method checkSelfServiceOptions [line 726]
array checkSelfServiceOptions(
string
$fields, array
$attributes)
|
|
Checks if all input values are correct and returns the LDAP commands which should be executed.
Tags:
Overridden in child classes as:
- inetOrgPerson::checkSelfServiceOptions()
- Checks if all input values are correct and returns the LDAP commands which should be executed.
- posixAccount::checkSelfServiceOptions()
- Checks if all input values are correct and returns the LDAP commands which should be executed.
- sambaSamAccount::checkSelfServiceOptions()
- Checks if all input values are correct and returns the LDAP commands which should be executed.
Parameters:
method checkSelfServiceSettings [line 747]
array checkSelfServiceSettings(
array
$options)
|
|
Checks if the self service settings are valid.
Tags:
Parameters:
method check_configOptions [line 355]
array check_configOptions(
array
$scopes, array
$options)
|
|
Checks input values of module settings.
Tags:
Overridden in child classes as:
- posixAccount::check_configOptions()
- Checks input values of module settings.
Parameters:
method check_profileOptions [line 240]
array check_profileOptions(
array
$options)
|
|
Checks input values of account profiles.
Tags:
Overridden in child classes as:
- quota::check_profileOptions()
- Checks input values of account profiles.
Parameters:
method delete_attributes [line 628]
List delete_attributes(
)
|
|
Dummy function for modules which use no special options on account deletion.
Tags:
Overridden in child classes as:
- posixAccount::delete_attributes()
- Additional LDAP operations on delete.
- posixGroup::delete_attributes()
- Checks if the group which should be deleted is still used as primary group.
method display_html_delete [line 637]
meta display_html_delete(
)
|
|
Dummy function for modules which do not print extra HTML code on account deletion.
Tags:
Overridden in child classes as:
- posixAccount::display_html_delete()
- Displays the delete homedir option for the delete page.
method doUploadPostActions [line 563]
array doUploadPostActions(
array
$data, array
$ids, array
$failed,
&$temp, array
$temp)
|
|
This function executes one post upload action.
Tags:
Overridden in child classes as:
- posixAccount::doUploadPostActions()
- This function executes one post upload action.
- quota::doUploadPostActions()
- This function executes one post upload action.
Parameters:
method getAccountContainer [line 758]
Returns the accountContainer object.
Tags:
method getAttributes [line 772]
Returns the LDAP attributes which are managed in this module.
Tags:
method getButtonStatus [line 545]
method getLDAPAliases [line 658]
Returns a list of aliases for LDAP attributes.
All alias attributes will be renamed to the given attribute names.
Tags:
method getManagedAttributes [line 669]
array getManagedAttributes(
)
|
|
Returns a list of LDAP attributes which are managed by this module.
All attribute names will be renamed to match the given spelling.
Tags:
method getManagedObjectClasses [line 647]
array getManagedObjectClasses(
)
|
|
Returns a list of managed object classes for this module.
This is used to fix incorrect spelled object class names.
Tags:
method getOriginalAttributes [line 781]
array getOriginalAttributes(
)
|
|
Returns the LDAP attributes which are managed in this module (with unchanged values).
Tags:
method getRequiredExtensions [line 679]
array getRequiredExtensions(
)
|
|
Returns a list of required PHP extensions.
Tags:
method getSelfServiceFields [line 700]
array getSelfServiceFields(
)
|
|
Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
Tags:
method getSelfServiceOptions [line 714]
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:
Overridden in child classes as:
- inetOrgPerson::getSelfServiceOptions()
- Returns the meta HTML code for each input field.
- posixAccount::getSelfServiceOptions()
- Returns the meta HTML code for each input field.
Parameters:
method getSelfServiceSearchAttributes [line 689]
array getSelfServiceSearchAttributes(
)
|
|
Returns a list of possible search attributes for the self service.
Tags:
method getSelfServiceSettings [line 736]
array getSelfServiceSettings(
)
|
|
Returns a list of self service configuration settings.
Tags:
method get_alias [line 195]
Returns an alias name for the module.
This alias is used in various places instead of the less descriptive class name. The alias also has less syntax restrictions and may contain spaces or special characters.
Tags:
method get_configOptions [line 339]
array get_configOptions(
array
$scopes, array
$allScopes)
|
|
Returns a list of elements for the configuration.
Tags:
Overridden in child classes as:
- posixGroup::get_configOptions()
- Returns a list of elements for the configuration.
Parameters:
method get_dependencies [line 219]
array get_dependencies(
)
|
|
This function returns a list with all depending and conflicting modules.
Tags:
method get_help [line 509]
array get_help(
string
$id, string
$scope)
|
|
This function return the help entry array for a specific help id. Normally this->meta can be used.
Tags:
Parameters:
method get_ldap_filter [line 182]
string get_ldap_filter(
)
|
|
returns an LDAP filter for the account lists
Tags:
method get_metaData [line 142]
method get_pdfFields [line 439]
array get_pdfFields(
string
$scope)
|
|
Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
Tags:
Parameters:
method get_pdf_entries [line 454]
array get_pdf_entries(
[string
$scope = 'user'])
|
|
Returns a hastable with all entries that may be printed out in the PDF. The
syntax of the hashtable is specified by the module specification and the corresponding DTD. This method must be overwritten in case that there are non static things to be returned. The $this->meta['PDF_entries'] array may be used when there is only static content.
Tags:
Parameters:
method get_profileOptions [line 229]
method get_RDNAttributes [line 209]
array get_RDNAttributes(
)
|
|
Returns a list of possible LDAP attributes which can be used to form the RDN.
The returned elements have this form: <attribute> => <priority>
<attribute> is the name of the LDAP attribute
<priority> defines the priority of the attribute (can be "low", "normal", "high")
Tags:
method get_scope [line 151]
Returns the account type of this module (user, group, host)
Tags:
method get_uploadColumns [line 472]
array get_uploadColumns(
)
|
|
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:
Overridden in child classes as:
- quota::get_uploadColumns()
- Returns an array containing all input columns for the file upload.
method get_uploadPreDepends [line 482]
array get_uploadPreDepends(
)
|
|
Returns a list of module names which must be processed in building the account befor this module.
Tags:
method init [line 91]
Initializes the module after it became part of an accountContainer
Overridden in child classes as:
- posixAccount::init()
- Initializes the module after it became part of an accountContainer
- posixGroup::init()
- This functin will be called when the module will be loaded *
- sambaAccount::init()
- Initializes the module after it became part of an accountContainer
- sambaGroupMapping::init()
- Initializes the module after it became part of an accountContainer
- sambaSamAccount::init()
- Initializes the module after it became part of an accountContainer
Parameters:
method is_base_module [line 172]
boolean is_base_module(
)
|
|
Returns true if this module is enough to provide a sensible account.
There is no relation to the name of this class.
Tags:
method load_attributes [line 110]
method load_Messages [line 83]
method load_profile [line 321]
method module_complete [line 536]
method module_ready [line 527]
This function is used to check if this module page can be displayed.
It returns false if a module depends on data from other modules which was not yet entered.
Tags:
Overridden in child classes as:
- quota::module_ready()
- This function is used to check if this module page can be displayed.
- sambaAccount::module_ready()
- This function is used to check if this module page can be displayed.
- sambaGroupMapping::module_ready()
- This function is used to check if this module page can be displayed.
- sambaSamAccount::module_ready()
- This function is used to check if this module page can be displayed.
method postDeleteActions [line 619]
void postDeleteActions(
)
|
|
Allows the module to run commands after the LDAP entry is deleted.
method postModifyActions [line 602]
void postModifyActions(
boolean
$newAccount)
|
|
Allows the module to run commands after the LDAP entry is changed or created.
Overridden in child classes as:
- posixAccount::postModifyActions()
- Allows the module to run commands after the LDAP entry was changed or created.
- quota::postModifyActions()
- Allows the module to run commands after the LDAP entry is changed or created.
Parameters:
method preDeleteActions [line 612]
true, preDeleteActions(
)
|
|
Allows the module to run commands before the LDAP entry is deleted.
An error message should be printed if the function returns false.
Tags:
Overridden in child classes as:
- posixAccount::preDeleteActions()
- Allows the module to run commands before the LDAP entry is deleted.
- quota::preDeleteActions()
- Allows the module to run commands before the LDAP entry is deleted.
method preModifyActions [line 593]
true, preModifyActions(
boolean
$newAccount)
|
|
Allows the module to run commands before the LDAP entry is changed or created.
An error message should be printed if the function returns false.
Tags:
Parameters:
method save_attributes [line 582]