Procedural File: modules.inc
Source Location: /lib/modules.inc
Classes:
accountContainer
This class includes all modules and attributes of an account.
passwordService
This interface needs to be implemented by all account modules which manage passwords.
Page Details:
Interface between modules and other parts of LAM.
Tags:
Includes:
buildUploadAccounts [line 422]
mixed buildUploadAccounts(
string $scope, array $data, array $ids, array $selectedModules)
|
|
This function builds the LDAP accounts for the file upload. If there are problems status messages will be printed automatically.
Tags:
Parameters
string |
$scope |
account type |
array |
$data |
array containing one account in each element |
array |
$ids |
array(<column_name> => <column number>) |
array |
$selectedModules |
selected account modules |
checkConfigOptions [line 323]
array checkConfigOptions(
array $scopes, array $options)
|
|
Checks if the configuration options are valid
Tags:
Parameters
array |
$scopes |
hash array (module name => array(account types)) |
array |
$options |
hash array containing all options (name => array(...)) |
checkProfileOptions [line 289]
array checkProfileOptions(
string $scope, array $options)
|
|
Checks if the profile options are valid
Tags:
Parameters
string |
$scope |
account type (user, group, host) |
array |
$options |
hash array containing all options (name => array(...)) |
check_module_conflicts [line 233]
boolean check_module_conflicts(
array $selected, array $deps)
|
|
Checks if there are conflicts between modules
Tags:
Parameters
array |
$selected |
selected module names |
array |
$deps |
module dependencies |
check_module_depends [line 192]
mixed check_module_depends(
array $selected, array $deps)
|
|
Checks if there are missing dependencies between modules.
Tags:
Parameters
array |
$selected |
selected module names |
array |
$deps |
module dependencies |
doUploadPostActions [line 504]
array doUploadPostActions(
string $scope, &$data, array $ids, array $failed, array $selectedModules, &$accounts, array $data, array $accounts)
|
|
This function executes one post upload action.
Tags:
Parameters
string |
$scope |
account type |
array |
$data |
array containing one account in each element |
array |
$ids |
array(<column_name> => <column number>) |
array |
$failed |
list of accounts which were not created successfully |
array |
$selectedModules |
list of selected account modules |
array |
$accounts |
list of LDAP entries |
|
&$data |
|
|
&$accounts |
|
getAvailableModules [line 252]
array getAvailableModules(
string $scope)
|
|
Returns an array with all available user module names
Tags:
Parameters
string |
$scope |
account type (user, group, host) |
getAvailablePDFFields [line 363]
array getAvailablePDFFields(
string $scope)
|
|
Returns a list of available PDF entries.
Tags:
Parameters
string |
$scope |
account type (user, group, host) |
getConfigOptions [line 306]
array getConfigOptions(
array $scopes)
|
|
Returns a hash array (module name => elements) of all module options for the configuration page.
Tags:
Parameters
array |
$scopes |
hash array (module name => array(account types)) |
getHelp [line 344]
array getHelp(
string $module, string $helpID, [string $scope = ''])
|
|
Returns a help entry from an account module.
Tags:
Parameters
string |
$module |
module name |
string |
$helpID |
help identifier |
string |
$scope |
account type |
getModuleAlias [line 65]
string getModuleAlias(
string $name, string $scope)
|
|
Returns the alias name of a module
Tags:
Parameters
string |
$name |
the module name |
string |
$scope |
the account type ("user", "group", "host") |
getModulesDependencies [line 174]
array getModulesDependencies(
string $scope)
|
|
Returns a hash array (module name => dependencies) of all module dependencies "dependencies" contains an array with two sub arrays: depends, conflicts The elements of "depends" are either module names or an array of module names (OR-case). The elements of conflicts are module names.
Tags:
Parameters
string |
$scope |
the account type (user, group, host) |
getProfileOptions [line 272]
array getProfileOptions(
string $scope)
|
|
Returns the elements for the profile page.
Tags:
Parameters
string |
$scope |
account type (user, group, host) |
getRDNAttributes [line 121]
array getRDNAttributes(
string $scope, [array $selectedModules = null])
|
|
Returns a list of LDAP attributes which can be used to form the RDN. The list is already sorted by the priority given by the nodules.
Tags:
Parameters
string |
$scope |
account type (user, group, host) |
array |
$selectedModules |
return only RDN attributes of these modules |
getRequiredExtensions [line 540]
array getRequiredExtensions(
)
|
|
Returns true if the module is a base module
Tags:
getUploadColumns [line 402]
array getUploadColumns(
string $scope, 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:
Parameters
string |
$scope |
account type |
array |
$selectedModules |
selected account modules |
get_ldap_filter [line 88]
string get_ldap_filter(
string $scope)
|
|
Returns the LDAP filter used by the account lists
Tags:
Parameters
string |
$scope |
the account type ("user", "group", "host") |
is_base_module [line 77]
boolean is_base_module(
string $name, string $scope)
|
|
Returns true if the module is a base module
Tags:
Parameters
string |
$name |
the module name |
string |
$scope |
the account type ("user", "group", "host") |
lamCompareDescriptiveOptions [line 592]
integer lamCompareDescriptiveOptions(
&$a, &$b, array $a, array $b)
|
|
Helper function to sort descriptive options in parseHTML(). It compares the second entries of two arrays.
Tags:
Parameters
array |
$a |
first array |
array |
$b |
second array |
|
&$a |
|
|
&$b |
|
parseHtml [line 570]
array parseHtml(
string $module, mixed $input, array $values, boolean $restricted, &$tabindex, string $scope, integer $tabindex)
|
|
Takes a list of meta-HTML elements and prints the equivalent HTML output. The modules are not allowed to display HTML code directly but return meta HTML code. This allows to have a common design for all module pages.
Tags:
Parameters
string |
$module |
Name of account module |
mixed |
$input |
htmlElement or array of htmlElement elements |
array |
$values |
List of values which override the defaults in $input (name => value) |
boolean |
$restricted |
If true then no buttons will be displayed |
integer |
$tabindex |
Start value of tabulator index for input fields |
string |
$scope |
Account type |
|
&$tabindex |
|
printHelpLink [line 608]
void printHelpLink(
array $entry, String $number, [String $module = ''], [String $scope = ''])
|
|
Prints a LAM help link.
Parameters
array |
$entry |
help entry |
String |
$number |
help number |
String |
$module |
module name |
String |
$scope |
account scope |
|
|