1412 lines
51 KiB
HTML
1412 lines
51 KiB
HTML
<html>
|
|
<head>
|
|
<title>Docs For Class posixAccount</title>
|
|
<link rel="stylesheet" type="text/css" href="../media/style.css">
|
|
</head>
|
|
<body>
|
|
|
|
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
|
|
<tr>
|
|
<td class="header_top">modules</td>
|
|
</tr>
|
|
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
|
|
<tr>
|
|
<td class="header_menu">
|
|
|
|
|
|
[ <a href="../classtrees_modules.html" class="menu">class tree: modules</a> ]
|
|
[ <a href="../elementindex_modules.html" class="menu">index: modules</a> ]
|
|
[ <a href="../elementindex.html" class="menu">all elements</a> ]
|
|
</td>
|
|
</tr>
|
|
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
|
|
</table>
|
|
|
|
<table width="100%" border="0" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="200" class="menu">
|
|
<div id="ric">
|
|
<p><a href="../ric_INSTALL.html">INSTALL</a></p>
|
|
<p><a href="../ric_README.html">README</a></p>
|
|
</div>
|
|
<b>Packages:</b><br />
|
|
<a href="../li_configuration.html">configuration</a><br />
|
|
<a href="../li_Help.html">Help</a><br />
|
|
<a href="../li_LDAP.html">LDAP</a><br />
|
|
<a href="../li_lib.html">lib</a><br />
|
|
<a href="../li_lists.html">lists</a><br />
|
|
<a href="../li_main.html">main</a><br />
|
|
<a href="../li_modules.html">modules</a><br />
|
|
<a href="../li_PDF.html">PDF</a><br />
|
|
<a href="../li_profiles.html">profiles</a><br />
|
|
<a href="../li_selfService.html">selfService</a><br />
|
|
<a href="../li_tests.html">tests</a><br />
|
|
<a href="../li_tools.html">tools</a><br />
|
|
<a href="../li_types.html">types</a><br />
|
|
<br /><br />
|
|
<b>Files:</b><br />
|
|
<div class="package">
|
|
<a href="../modules/_lib---modules---account.inc.html"> account.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---baseModule.inc.html"> baseModule.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---createntlm.inc.html"> createntlm.inc
|
|
</a><br>
|
|
<a href="../modules/_templates---account---edit.php.html"> edit.php
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---ieee802device.inc.html"> ieee802device.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---inetLocalMailRecipient.inc.html"> inetLocalMailRecipient.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---inetOrgPerson.inc.html"> inetOrgPerson.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---kolabUser.inc.html"> kolabUser.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---lamdaemon.inc.html"> lamdaemon.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---ldapPublicKey.inc.html"> ldapPublicKey.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules.inc.html"> modules.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---nisMailAlias.inc.html"> nisMailAlias.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---posixAccount.inc.html"> posixAccount.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---posixGroup.inc.html"> posixGroup.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---quota.inc.html"> quota.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaAccount.inc.html"> sambaAccount.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaDomain.inc.html"> sambaDomain.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaGroupMapping.inc.html"> sambaGroupMapping.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html"> sambaMungedDial.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaSamAccount.inc.html"> sambaSamAccount.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---shadowAccount.inc.html"> shadowAccount.inc
|
|
</a><br>
|
|
</div><br />
|
|
|
|
|
|
|
|
<b>Classes:</b><br />
|
|
<div class="package">
|
|
<a href="../modules/account.html">account</a><br />
|
|
<a href="../modules/accountContainer.html">accountContainer</a><br />
|
|
<a href="../modules/baseModule.html">baseModule</a><br />
|
|
<a href="../modules/ieee802Device.html">ieee802Device</a><br />
|
|
<a href="../modules/inetLocalMailRecipient.html">inetLocalMailRecipient</a><br />
|
|
<a href="../modules/inetOrgPerson.html">inetOrgPerson</a><br />
|
|
<a href="../modules/kolabUser.html">kolabUser</a><br />
|
|
<a href="../modules/ldapPublicKey.html">ldapPublicKey</a><br />
|
|
<a href="../modules/nisMailAlias.html">nisMailAlias</a><br />
|
|
<a href="../modules/posixAccount.html">posixAccount</a><br />
|
|
<a href="../modules/posixGroup.html">posixGroup</a><br />
|
|
<a href="../modules/quota.html">quota</a><br />
|
|
<a href="../modules/samba3domain.html">samba3domain</a><br />
|
|
<a href="../modules/sambaAccount.html">sambaAccount</a><br />
|
|
<a href="../modules/sambaDomain.html">sambaDomain</a><br />
|
|
<a href="../modules/sambaGroupMapping.html">sambaGroupMapping</a><br />
|
|
<a href="../modules/sambaMungedDial.html">sambaMungedDial</a><br />
|
|
<a href="../modules/sambaSamAccount.html">sambaSamAccount</a><br />
|
|
<a href="../modules/shadowAccount.html">shadowAccount</a><br />
|
|
<a href="../modules/smbHash.html">smbHash</a><br />
|
|
</div>
|
|
|
|
</td>
|
|
<td>
|
|
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
|
|
|
|
<h1>Class: posixAccount</h1>
|
|
Source Location: /lib/modules/posixAccount.inc<br /><br />
|
|
|
|
|
|
<table width="100%" border="0">
|
|
<tr><td valign="top">
|
|
|
|
<h3><a href="#class_details">Class Overview</a></h3>
|
|
<pre><a href="../modules/baseModule.html">baseModule</a>
|
|
|
|
|
--posixAccount</pre><br />
|
|
<div class="description">Manages the object class "posixAccount" for users and hosts.</div><br /><br />
|
|
<h4>Author(s):</h4>
|
|
<ul>
|
|
<li>Roland Gruber</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td valign="top">
|
|
<h3><a href="#class_methods">Methods</a></h3>
|
|
<ul>
|
|
<li><a href="../modules/posixAccount.html#methodbuild_uploadAccounts">build_uploadAccounts</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodcheckASCII">checkASCII</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodcheckSelfServiceOptions">checkSelfServiceOptions</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodcheck_configOptions">check_configOptions</a></li>
|
|
<li><a href="../modules/posixAccount.html#methoddelete_attributes">delete_attributes</a></li>
|
|
<li><a href="../modules/posixAccount.html#methoddisplay_html_attributes">display_html_attributes</a></li>
|
|
<li><a href="../modules/posixAccount.html#methoddisplay_html_delete">display_html_delete</a></li>
|
|
<li><a href="../modules/posixAccount.html#methoddisplay_html_group">display_html_group</a></li>
|
|
<li><a href="../modules/posixAccount.html#methoddisplay_html_password">display_html_password</a></li>
|
|
<li><a href="../modules/posixAccount.html#methoddoUploadPostActions">doUploadPostActions</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodgetClearTextPassword">getClearTextPassword</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodgetNextUIDs">getNextUIDs</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodgetSelfServiceOptions">getSelfServiceOptions</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodget_metaData">get_metaData</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodget_pdfEntries">get_pdfEntries</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodget_profileOptions">get_profileOptions</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodinit">init</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodload_attributes">load_attributes</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodload_Messages">load_Messages</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodload_profile">load_profile</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodmodule_complete">module_complete</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodpostModifyActions">postModifyActions</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodpreDeleteActions">preDeleteActions</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodprocess_attributes">process_attributes</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodprocess_group">process_group</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodprocess_password">process_password</a></li>
|
|
<li><a href="../modules/posixAccount.html#methodsave_attributes">save_attributes</a></li>
|
|
</ul>
|
|
</td>
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<table width="100%" border="0"><tr>
|
|
|
|
|
|
|
|
|
|
<td valign="top">
|
|
<h3>Inherited Variables</h3>
|
|
<div class="tags">
|
|
<h4>Class: <a href="../modules/baseModule.html">baseModule</a></h4>
|
|
<dl>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$attributes">baseModule::$attributes</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$autoAddObjectClasses">baseModule::$autoAddObjectClasses</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$messages">baseModule::$messages</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$meta">baseModule::$meta</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$moduleSettings">baseModule::$moduleSettings</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$orig">baseModule::$orig</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$selfServiceSettings">baseModule::$selfServiceSettings</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</td>
|
|
|
|
<td valign="top">
|
|
<h3>Inherited Methods</h3>
|
|
<div class="tags">
|
|
<h4>Class: <a href="../modules/baseModule.html">baseModule</a></h4>
|
|
<dl>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#method__construct">baseModule::__construct()</a>
|
|
</dt>
|
|
<dd>
|
|
Creates a new base module class
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodbuild_uploadAccounts">baseModule::build_uploadAccounts()</a>
|
|
</dt>
|
|
<dd>
|
|
In this function the LDAP accounts are built.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcan_manage">baseModule::can_manage()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns true if this module can manage accounts of the current type, otherwise false.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcheckSelfServiceOptions">baseModule::checkSelfServiceOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Checks if all input values are correct and returns the LDAP attributes which should be changed.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcheckSelfServiceSettings">baseModule::checkSelfServiceSettings()</a>
|
|
</dt>
|
|
<dd>
|
|
Checks if the self service settings are valid.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcheck_configOptions">baseModule::check_configOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Checks input values of module settings.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcheck_profileOptions">baseModule::check_profileOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Checks input values of account profiles.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methoddelete_attributes">baseModule::delete_attributes()</a>
|
|
</dt>
|
|
<dd>
|
|
This function returns an array with the same syntax as save_attributes().
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methoddisplay_html_attributes">baseModule::display_html_attributes()</a>
|
|
</dt>
|
|
<dd>
|
|
This function creates meta HTML code to display the module page.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methoddisplay_html_delete">baseModule::display_html_delete()</a>
|
|
</dt>
|
|
<dd>
|
|
This function creates meta HTML code which will be displayed when an account should be deleted.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methoddoUploadPostActions">baseModule::doUploadPostActions()</a>
|
|
</dt>
|
|
<dd>
|
|
This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetAccountContainer">baseModule::getAccountContainer()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the <a href="../modules/accountContainer.html">accountContainer</a> object.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetAttributes">baseModule::getAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the LDAP attributes which are managed in this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetButtonStatus">baseModule::getButtonStatus()</a>
|
|
</dt>
|
|
<dd>
|
|
Controls if the module button the account page is visible and activated.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetIcon">baseModule::getIcon()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the path to the module icon.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetLDAPAliases">baseModule::getLDAPAliases()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of aliases for LDAP attributes.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetManagedAttributes">baseModule::getManagedAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of LDAP attributes which are managed by this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetManagedObjectClasses">baseModule::getManagedObjectClasses()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of managed object classes for this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetOriginalAttributes">baseModule::getOriginalAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the LDAP attributes which are managed in this module (with unchanged values).
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetRequiredExtensions">baseModule::getRequiredExtensions()</a>
|
|
</dt>
|
|
<dd>
|
|
This function returns a list of PHP extensions (e.g. mhash) which are needed by this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetSelfServiceFields">baseModule::getSelfServiceFields()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of possible input fields and their descriptions.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetSelfServiceOptions">baseModule::getSelfServiceOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the meta HTML code for each input field.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetSelfServiceSearchAttributes">baseModule::getSelfServiceSearchAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetSelfServiceSettings">baseModule::getSelfServiceSettings()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of self service configuration settings.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_alias">baseModule::get_alias()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns an alias name for the module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_configOptions">baseModule::get_configOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of configuration options.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_dependencies">baseModule::get_dependencies()</a>
|
|
</dt>
|
|
<dd>
|
|
This function returns a list with all depending and conflicting modules.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_help">baseModule::get_help()</a>
|
|
</dt>
|
|
<dd>
|
|
This function returns the help entry array for a specific help id.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_ldap_filter">baseModule::get_ldap_filter()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns an LDAP filter for the account lists
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a>
|
|
</dt>
|
|
<dd>
|
|
This function provides meta data which is interpreted by baseModule.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_pdfFields">baseModule::get_pdfFields()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a hashtable with all entries that may be printed out in the PDF.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_profileOptions">baseModule::get_profileOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
This function defines what attributes will be used in the account profiles and their appearance in the profile editor.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_RDNAttributes">baseModule::get_RDNAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_scope">baseModule::get_scope()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the account type of this module (user, group, host)
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_uploadColumns">baseModule::get_uploadColumns()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns an array containing all input columns for the file upload.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_uploadPreDepends">baseModule::get_uploadPreDepends()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of module names which must be processed in building the account befor this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodinit">baseModule::init()</a>
|
|
</dt>
|
|
<dd>
|
|
Initializes the module after it became part of an <a href="../modules/accountContainer.html">accountContainer</a>
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodis_base_module">baseModule::is_base_module()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns true if your module is a base module and otherwise false.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodload_attributes">baseModule::load_attributes()</a>
|
|
</dt>
|
|
<dd>
|
|
This function loads the LDAP attributes when an account should be loaded.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodload_Messages">baseModule::load_Messages()</a>
|
|
</dt>
|
|
<dd>
|
|
This function fills the $messages variable with output messages from this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodload_profile">baseModule::load_profile()</a>
|
|
</dt>
|
|
<dd>
|
|
This function loads the values from an account profile to the module's internal data structures.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodmodule_complete">baseModule::module_complete()</a>
|
|
</dt>
|
|
<dd>
|
|
This functions is used to check if all settings for this module have been made.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodmodule_ready">baseModule::module_ready()</a>
|
|
</dt>
|
|
<dd>
|
|
This function is used to check if this module page can be displayed.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodpostDeleteActions">baseModule::postDeleteActions()</a>
|
|
</dt>
|
|
<dd>
|
|
Allows the module to run commands after the LDAP entry is deleted.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodpostModifyActions">baseModule::postModifyActions()</a>
|
|
</dt>
|
|
<dd>
|
|
Allows the module to run commands after the LDAP entry is changed or created.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodpreDeleteActions">baseModule::preDeleteActions()</a>
|
|
</dt>
|
|
<dd>
|
|
Allows the module to run commands before the LDAP entry is deleted.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodpreModifyActions">baseModule::preModifyActions()</a>
|
|
</dt>
|
|
<dd>
|
|
Allows the module to run commands before the LDAP entry is changed or created.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodprocess_attributes">baseModule::process_attributes()</a>
|
|
</dt>
|
|
<dd>
|
|
This function processes user input.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodsave_attributes">baseModule::save_attributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of modifications which have to be made to the LDAP account.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</td>
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<a name="class_details"></a>
|
|
<h3>Class Details</h3>
|
|
<div class="tags">
|
|
[line 40]<br />
|
|
Manages the object class "posixAccount" for users and hosts.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>author:</b> </td><td>Roland Gruber</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div><br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
|
|
|
|
|
<hr />
|
|
<a name="class_methods"></a>
|
|
<h3>Class Methods</h3>
|
|
<div class="tags">
|
|
|
|
<hr />
|
|
<a name="methodbuild_uploadAccounts"></a>
|
|
<h3>method build_uploadAccounts <span class="smalllinenumber">[line 1273]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array build_uploadAccounts(
|
|
array
|
|
$rawAccounts, array
|
|
$ids,
|
|
&$partialAccounts, array
|
|
$partialAccounts)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
In this function the LDAP account is built up.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of error messages if any</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodbuild_uploadAccounts">baseModule::build_uploadAccounts()</a> (In this function the LDAP accounts are built.)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$rawAccounts</b> </td>
|
|
<td>list of hash arrays (name => value) from user input</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$partialAccounts</b> </td>
|
|
<td>list of hash arrays (name => value) which are later added to LDAP</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$ids</b> </td>
|
|
<td>list of IDs for column position (e.g. "posixAccount_uid" => 5)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>&$partialAccounts</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodcheckASCII"></a>
|
|
<h3>method checkASCII <span class="smalllinenumber">[line 857]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>string checkASCII(
|
|
string
|
|
$attribute)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Checks if an attribute contains only ASCII charaters and replaces invalid characters.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>attribute value with replaced non-ASCII characters</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">string </td>
|
|
<td><b>$attribute</b> </td>
|
|
<td>attribute value</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodcheckSelfServiceOptions"></a>
|
|
<h3>method checkSelfServiceOptions <span class="smalllinenumber">[line 1720]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array checkSelfServiceOptions(
|
|
string
|
|
$fields, array
|
|
$attributes)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Checks if all input values are correct and returns the LDAP commands which should be executed.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodcheckSelfServiceOptions">baseModule::checkSelfServiceOptions()</a> (Checks if all input values are correct and returns the LDAP attributes which should be changed.)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">string </td>
|
|
<td><b>$fields</b> </td>
|
|
<td>input fields</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$attributes</b> </td>
|
|
<td>LDAP attributes</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodcheck_configOptions"></a>
|
|
<h3>method check_configOptions <span class="smalllinenumber">[line 1214]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array check_configOptions(
|
|
array
|
|
$scopes, array
|
|
$options)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Checks input values of module settings.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of error messages</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodcheck_configOptions">baseModule::check_configOptions()</a> (Checks input values of module settings.)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$scopes</b> </td>
|
|
<td>list of account types which are used</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$options</b> </td>
|
|
<td>hash array containing the settings (array('option' => array('value')))</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methoddelete_attributes"></a>
|
|
<h3>method delete_attributes <span class="smalllinenumber">[line 578]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>List delete_attributes(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Additional LDAP operations on delete.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>of LDAP operations, same as for save_attributes()</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methoddelete_attributes">baseModule::delete_attributes()</a> (This function returns an array with the same syntax as save_attributes().)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methoddisplay_html_attributes"></a>
|
|
<h3>method display_html_attributes <span class="smalllinenumber">[line 928]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array display_html_attributes(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the HTML meta data for the main account page.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>HTML meta data</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methoddisplay_html_attributes">baseModule::display_html_attributes()</a> (This function creates meta HTML code to display the module page.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methoddisplay_html_delete"></a>
|
|
<h3>method display_html_delete <span class="smalllinenumber">[line 1034]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>meta display_html_delete(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Displays the delete homedir option for the delete page.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>HTML code</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methoddisplay_html_delete">baseModule::display_html_delete()</a> (This function creates meta HTML code which will be displayed when an account should be deleted.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methoddisplay_html_group"></a>
|
|
<h3>method display_html_group <span class="smalllinenumber">[line 1049]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array display_html_group(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Displays the group selection.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>meta HTML code</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methoddisplay_html_password"></a>
|
|
<h3>method display_html_password <span class="smalllinenumber">[line 1094]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array display_html_password(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Displays the password changing dialog.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>meta HTML code</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methoddoUploadPostActions"></a>
|
|
<h3>method doUploadPostActions <span class="smalllinenumber">[line 1525]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array doUploadPostActions(
|
|
array
|
|
$data, array
|
|
$ids, array
|
|
$failed,
|
|
&$temp, array
|
|
$temp)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
This function executes one post upload action.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>current status <br /> array ( <br /> 'status' => 'finished' | 'inProgress' <br /> 'progress' => 0..100 <br /> 'errors' => array (<array of parameters for StatusMessage>) <br /> )</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methoddoUploadPostActions">baseModule::doUploadPostActions()</a> (This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$data</b> </td>
|
|
<td>array containing one account in each element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$ids</b> </td>
|
|
<td>array(<column_name> => <column number>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$failed</b> </td>
|
|
<td>list of accounts which were not created successfully</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$temp</b> </td>
|
|
<td>variable to store temporary data between two post actions</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>&$temp</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetClearTextPassword"></a>
|
|
<h3>method getClearTextPassword <span class="smalllinenumber">[line 1749]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>string getClearTextPassword(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the clear text password.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>password</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>access:</b> </td><td>public</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetNextUIDs"></a>
|
|
<h3>method getNextUIDs <span class="smalllinenumber">[line 1634]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>mixed getNextUIDs(
|
|
integer
|
|
$count,
|
|
&$errors, array
|
|
$errors)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns one or more free UID numbers.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>Null if no UIDs are free else an array of free UIDs.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">integer </td>
|
|
<td><b>$count</b> </td>
|
|
<td>Number of needed free UIDs.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$errors</b> </td>
|
|
<td>list of error messages where errors can be added</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>&$errors</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetSelfServiceOptions"></a>
|
|
<h3>method getSelfServiceOptions <span class="smalllinenumber">[line 1700]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array getSelfServiceOptions(
|
|
array
|
|
$fields, array
|
|
$attributes)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the meta HTML code for each input field.<br /><br /><p>format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>meta HTML</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodgetSelfServiceOptions">baseModule::getSelfServiceOptions()</a> (Returns the meta HTML code for each input field.)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$fields</b> </td>
|
|
<td>list of active fields</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$attributes</b> </td>
|
|
<td>attributes of LDAP account (attribute names in lower case)</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodget_metaData"></a>
|
|
<h3>method get_metaData <span class="smalllinenumber">[line 104]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array get_metaData(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns meta data that is interpreted by parent class<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>array with meta data</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a> (This function provides meta data which is interpreted by baseModule.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodget_pdfEntries"></a>
|
|
<h3>method get_pdfEntries <span class="smalllinenumber">[line 1189]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array get_pdfEntries(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the PDF entries for this module.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of possible PDF entries</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodget_profileOptions"></a>
|
|
<h3>method get_profileOptions <span class="smalllinenumber">[line 1125]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>profile get_profileOptions(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns a list of elements for the account profiles.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>elements</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodget_profileOptions">baseModule::get_profileOptions()</a> (This function defines what attributes will be used in the account profiles and their appearance in the profile editor.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodinit"></a>
|
|
<h3>method init <span class="smalllinenumber">[line 432]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void init(
|
|
string
|
|
$base)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Initializes the module after it became part of an accountContainer<br /><br /><br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodinit">baseModule::init()</a> (Initializes the module after it became part of an <a href="../modules/accountContainer.html">accountContainer</a>)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">string </td>
|
|
<td><b>$base</b> </td>
|
|
<td>the name of the accountContainer object ($_SESSION[$base])</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodload_attributes"></a>
|
|
<h3>method load_attributes <span class="smalllinenumber">[line 464]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void load_attributes(
|
|
array
|
|
$attr)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
This function loads all needed LDAP attributes.<br /><br /><br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodload_attributes">baseModule::load_attributes()</a> (This function loads the LDAP attributes when an account should be loaded.)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$attr</b> </td>
|
|
<td>list of attributes</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodload_Messages"></a>
|
|
<h3>method load_Messages <span class="smalllinenumber">[line 54]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void load_Messages(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
This function fills the error message array with messages.<br /><br /><br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodload_Messages">baseModule::load_Messages()</a> (This function fills the $messages variable with output messages from this module.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodload_profile"></a>
|
|
<h3>method load_profile <span class="smalllinenumber">[line 1167]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void load_profile(
|
|
array
|
|
$profile)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Loads the values of an account profile into internal variables.<br /><br /><br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodload_profile">baseModule::load_profile()</a> (This function loads the values from an account profile to the module's internal data structures.)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$profile</b> </td>
|
|
<td>hash array with profile values (identifier => value)</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodmodule_complete"></a>
|
|
<h3>method module_complete <span class="smalllinenumber">[line 450]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>boolean module_complete(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
This functions is used to check if all settings for this module have been made.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>true, if settings are complete</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodmodule_complete">baseModule::module_complete()</a> (This functions is used to check if all settings for this module have been made.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodpostModifyActions"></a>
|
|
<h3>method postModifyActions <span class="smalllinenumber">[line 540]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void postModifyActions(
|
|
boolean
|
|
$newAccount)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Allows the module to run commands after the LDAP entry was changed or created.<br /><br /><br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodpostModifyActions">baseModule::postModifyActions()</a> (Allows the module to run commands after the LDAP entry is changed or created.)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">boolean </td>
|
|
<td><b>$newAccount</b> </td>
|
|
<td>new account</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodpreDeleteActions"></a>
|
|
<h3>method preDeleteActions <span class="smalllinenumber">[line 596]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>true, preDeleteActions(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Allows the module to run commands before the LDAP entry is deleted.<br /><br /><p>An error message should be printed if the function returns false.</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>if no problems occured</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodpreDeleteActions">baseModule::preDeleteActions()</a> (Allows the module to run commands before the LDAP entry is deleted.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodprocess_attributes"></a>
|
|
<h3>method process_attributes <span class="smalllinenumber">[line 630]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array process_attributes(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Processes user input of the primary module page.<br /><br /><p>It checks if all input values are correct and updates the associated LDAP attributes.</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of info/error messages</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodprocess_attributes">baseModule::process_attributes()</a> (This function processes user input.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodprocess_group"></a>
|
|
<h3>method process_group <span class="smalllinenumber">[line 882]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array process_group(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Processes user input of the group selection page.<br /><br /><p>It checks if all input values are correct and updates the associated LDAP attributes.</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of info/error messages</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodprocess_password"></a>
|
|
<h3>method process_password <span class="smalllinenumber">[line 899]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array process_password(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Processes user input of the password page.<br /><br /><p>It checks if all input values are correct and updates the associated LDAP attributes.</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of info/error messages</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodsave_attributes"></a>
|
|
<h3>method save_attributes <span class="smalllinenumber">[line 491]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array save_attributes(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns a list of modifications which have to be made to the LDAP account.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>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</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodsave_attributes">baseModule::save_attributes()</a> (Returns a list of modifications which have to be made to the LDAP account.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
</div><br />
|
|
|
|
|
|
<div class="credit">
|
|
<hr />
|
|
Documentation generated on Thu, 07 Feb 2008 20:26:44 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
|
|
</div>
|
|
</td></tr></table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html> |