<html>
<head>
<title>Docs For Class baseModule</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_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/_lib---modules---ddns.inc.html"> ddns.inc
</a><br>
<a href="../modules/_lib---modules---dhcp_settings.inc.html"> dhcp_settings.inc
</a><br>
<a href="../modules/_templates---account---edit.php.html"> edit.php
</a><br>
<a href="../modules/_lib---modules---fixed_ip.inc.html"> fixed_ip.inc
</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---phpGroupwareGroup.inc.html"> phpGroupwareGroup.inc
</a><br>
<a href="../modules/_lib---modules---phpGroupwareUser.inc.html"> phpGroupwareUser.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---range.inc.html"> range.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/ddns.html">ddns</a><br />
<a href="../modules/dhcp_settings.html">dhcp_settings</a><br />
<a href="../modules/fixed_ip.html">fixed_ip</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/phpGroupwareGroup.html">phpGroupwareGroup</a><br />
<a href="../modules/phpGroupwareUser.html">phpGroupwareUser</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/range.html">range</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: baseModule</h1>
Source Location: /lib/baseModule.inc<br /><br />
<table width="100%" border="0">
<tr><td valign="top">
<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Parent class of all account modules.</div><br /><br />
<h4>Author(s):</h4>
<ul>
<li>Roland Gruber</li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
<li><a href="../modules/baseModule.html#var$attributes">$attributes</a></li>
<li><a href="../modules/baseModule.html#var$autoAddObjectClasses">$autoAddObjectClasses</a></li>
<li><a href="../modules/baseModule.html#var$messages">$messages</a></li>
<li><a href="../modules/baseModule.html#var$meta">$meta</a></li>
<li><a href="../modules/baseModule.html#var$moduleSettings">$moduleSettings</a></li>
<li><a href="../modules/baseModule.html#var$orig">$orig</a></li>
<li><a href="../modules/baseModule.html#var$selfServiceSettings">$selfServiceSettings</a></li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../modules/baseModule.html#method__construct">__construct</a></li>
<li><a href="../modules/baseModule.html#methodbuild_uploadAccounts">build_uploadAccounts</a></li>
<li><a href="../modules/baseModule.html#methodcan_manage">can_manage</a></li>
<li><a href="../modules/baseModule.html#methodcheckSelfServiceOptions">checkSelfServiceOptions</a></li>
<li><a href="../modules/baseModule.html#methodcheckSelfServiceSettings">checkSelfServiceSettings</a></li>
<li><a href="../modules/baseModule.html#methodcheck_configOptions">check_configOptions</a></li>
<li><a href="../modules/baseModule.html#methodcheck_profileOptions">check_profileOptions</a></li>
<li><a href="../modules/baseModule.html#methoddelete_attributes">delete_attributes</a></li>
<li><a href="../modules/baseModule.html#methoddisplay_html_attributes">display_html_attributes</a></li>
<li><a href="../modules/baseModule.html#methoddisplay_html_delete">display_html_delete</a></li>
<li><a href="../modules/baseModule.html#methoddoUploadPostActions">doUploadPostActions</a></li>
<li><a href="../modules/baseModule.html#methodgetAccountContainer">getAccountContainer</a></li>
<li><a href="../modules/baseModule.html#methodgetAttributes">getAttributes</a></li>
<li><a href="../modules/baseModule.html#methodgetButtonStatus">getButtonStatus</a></li>
<li><a href="../modules/baseModule.html#methodgetIcon">getIcon</a></li>
<li><a href="../modules/baseModule.html#methodgetLDAPAliases">getLDAPAliases</a></li>
<li><a href="../modules/baseModule.html#methodgetManagedAttributes">getManagedAttributes</a></li>
<li><a href="../modules/baseModule.html#methodgetManagedObjectClasses">getManagedObjectClasses</a></li>
<li><a href="../modules/baseModule.html#methodgetOriginalAttributes">getOriginalAttributes</a></li>
<li><a href="../modules/baseModule.html#methodgetRequiredExtensions">getRequiredExtensions</a></li>
<li><a href="../modules/baseModule.html#methodgetSelfServiceFields">getSelfServiceFields</a></li>
<li><a href="../modules/baseModule.html#methodgetSelfServiceOptions">getSelfServiceOptions</a></li>
<li><a href="../modules/baseModule.html#methodgetSelfServiceSearchAttributes">getSelfServiceSearchAttributes</a></li>
<li><a href="../modules/baseModule.html#methodgetSelfServiceSettings">getSelfServiceSettings</a></li>
<li><a href="../modules/baseModule.html#methodget_alias">get_alias</a></li>
<li><a href="../modules/baseModule.html#methodget_configOptions">get_configOptions</a></li>
<li><a href="../modules/baseModule.html#methodget_dependencies">get_dependencies</a></li>
<li><a href="../modules/baseModule.html#methodget_help">get_help</a></li>
<li><a href="../modules/baseModule.html#methodget_ldap_filter">get_ldap_filter</a></li>
<li><a href="../modules/baseModule.html#methodget_metaData">get_metaData</a></li>
<li><a href="../modules/baseModule.html#methodget_pdfFields">get_pdfFields</a></li>
<li><a href="../modules/baseModule.html#methodget_profileOptions">get_profileOptions</a></li>
<li><a href="../modules/baseModule.html#methodget_RDNAttributes">get_RDNAttributes</a></li>
<li><a href="../modules/baseModule.html#methodget_scope">get_scope</a></li>
<li><a href="../modules/baseModule.html#methodget_uploadColumns">get_uploadColumns</a></li>
<li><a href="../modules/baseModule.html#methodget_uploadPreDepends">get_uploadPreDepends</a></li>
<li><a href="../modules/baseModule.html#methodinit">init</a></li>
<li><a href="../modules/baseModule.html#methodis_base_module">is_base_module</a></li>
<li><a href="../modules/baseModule.html#methodload_attributes">load_attributes</a></li>
<li><a href="../modules/baseModule.html#methodload_Messages">load_Messages</a></li>
<li><a href="../modules/baseModule.html#methodload_profile">load_profile</a></li>
<li><a href="../modules/baseModule.html#methodmodule_complete">module_complete</a></li>
<li><a href="../modules/baseModule.html#methodmodule_ready">module_ready</a></li>
<li><a href="../modules/baseModule.html#methodpostDeleteActions">postDeleteActions</a></li>
<li><a href="../modules/baseModule.html#methodpostModifyActions">postModifyActions</a></li>
<li><a href="../modules/baseModule.html#methodpreDeleteActions">preDeleteActions</a></li>
<li><a href="../modules/baseModule.html#methodpreModifyActions">preModifyActions</a></li>
<li><a href="../modules/baseModule.html#methodprocess_attributes">process_attributes</a></li>
<li><a href="../modules/baseModule.html#methodsave_attributes">save_attributes</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
<td valign="top">
<h3>Child classes:</h3>
<div class="tags">
<dl>
<dt><a href="../modules/dhcp_settings.html">dhcp_settings</a></dt>
<dd>Parent class of all account modules.</dd>
</dl>
<dl>
<dt><a href="../modules/nisMailAlias.html">nisMailAlias</a></dt>
<dd>Provides NIS mail alias management.</dd>
</dl>
<dl>
<dt><a href="../modules/account.html">account</a></dt>
<dd>Manages the object class "account" for users and hosts.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html">ddns</a></dt>
<dd>Manages DDNS entries.</dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html">inetOrgPerson</a></dt>
<dd>This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).</dd>
</dl>
<dl>
<dt><a href="../modules/ieee802Device.html">ieee802Device</a></dt>
<dd>Provides MAC addresses for hosts.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareGroup.html">phpGroupwareGroup</a></dt>
<dd>Manages phpGroupware groups.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html">sambaAccount</a></dt>
<dd>Manages the object class "sambaAccount" for users and hosts.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html">sambaGroupMapping</a></dt>
<dd>Manages the object class "sambaGroupMapping" for groups.</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html">posixGroup</a></dt>
<dd>Manages the object class "posixGroup" for groups.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html">posixAccount</a></dt>
<dd>Manages the object class "posixAccount" for users and hosts.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html">kolabUser</a></dt>
<dd>Manages Kolab user accounts.</dd>
</dl>
<dl>
<dt><a href="../modules/ldapPublicKey.html">ldapPublicKey</a></dt>
<dd>Manages SSH public keys.</dd>
</dl>
<dl>
<dt><a href="../modules/inetLocalMailRecipient.html">inetLocalMailRecipient</a></dt>
<dd>Provides mail routing for users.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html">sambaSamAccount</a></dt>
<dd>Manages the object class "sambaSamAccount" for users and hosts.</dd>
</dl>
<dl>
<dt><a href="../modules/range.html">range</a></dt>
<dd>Manages DHCP ranges for DHCP server.</dd>
</dl>
<dl>
<dt><a href="../modules/quota.html">quota</a></dt>
<dd>Manages quotas for users and groups.</dd>
</dl>
<dl>
<dt><a href="../modules/shadowAccount.html">shadowAccount</a></dt>
<dd>Manages the object class "shadowAccount" for users.</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html">fixed_ip</a></dt>
<dd>Manages fixed IP addresses.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html">phpGroupwareUser</a></dt>
<dd>Manages phpGroupware users.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaDomain.html">sambaDomain</a></dt>
<dd>Manages Samba 3 domain entries.</dd>
</dl>
</div>
</td>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 53]<br />
Parent class of all account modules.<br /><br /><p>It implements the complete module interface and uses meta-data provided by the account modules for its functions.<br /> <br /> <strong>Location and naming of modules</strong><br /> All LAM modules are placed in lib/modules/ and are named "<class name>.inc". E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc". The class name of a module must contain only a-z, A-Z, 0-9, -, and _.<br /> <br /> You can avoid to override many functions by using <a href="../modules/baseModule.html#methodget_metaData">get_metaData()</a>.<br /> <br /> All module classes should extend the baseModule class.</p><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>
<tr>
<td><b>abstract:</b> </td><td></td>
</tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
<a name="var$attributes"></a>
<p></p>
<h4>$attributes = <span class="value"></span></h4>
<p>[line 71]</p>
contains all ldap attributes which should be written<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$autoAddObjectClasses"></a>
<p></p>
<h4>$autoAddObjectClasses = <span class="value"></span></h4>
<p>[line 80]</p>
if true, managed object classes are added when an account is created or loaded (default: true)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$messages"></a>
<p></p>
<h4>$messages = <span class="value"></span></h4>
<p>[line 77]</p>
contains all error messages of a module<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$meta"></a>
<p></p>
<h4>$meta = <span class="value"></span></h4>
<p>[line 56]</p>
includes all meta data provided by the sub class<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$moduleSettings"></a>
<p></p>
<h4>$moduleSettings = <span class="value"></span></h4>
<p>[line 62]</p>
configuration settings of all modules<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$orig"></a>
<p></p>
<h4>$orig = <span class="value"></span></h4>
<p>[line 74]</p>
contains all ldap attributes which are loaded from ldap<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<a name="var$selfServiceSettings"></a>
<p></p>
<h4>$selfServiceSettings = <span class="value"></span></h4>
<p>[line 65]</p>
self service settings of all modules<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>mixed</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="method__construct"></a>
<h3>constructor __construct <span class="smalllinenumber">[line 87]</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>baseModule __construct(
string
$scope)</code>
</td></tr></table>
</td></tr></table><br />
Creates a new base module class<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#method__construct">dhcp_settings::__construct()</a></dt>
<dd>Creates a new dhcp_settings object.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareGroup.html#method__construct">phpGroupwareGroup::__construct()</a></dt>
<dd>Creates a new kolabUser object.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#method__construct">sambaAccount::__construct()</a></dt>
<dd>Creates a new sambaAccount object.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#method__construct">sambaGroupMapping::__construct()</a></dt>
<dd>Creates a new module for Samba 3 groups.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#method__construct">kolabUser::__construct()</a></dt>
<dd>Creates a new kolabUser object.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#method__construct">sambaSamAccount::__construct()</a></dt>
<dd>Creates a new sambaSamAccount object.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html#method__construct">phpGroupwareUser::__construct()</a></dt>
<dd>Creates a new kolabUser object.</dd>
</dl>
</p>
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$scope</b> </td>
<td>the account type (user, group, host)</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodbuild_uploadAccounts"></a>
<h3>method build_uploadAccounts <span class="smalllinenumber">[line 854]</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 accounts are built.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> Returns an array which contains subarrays to generate StatusMessages if any errors occured.</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 error messages if any</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/nisMailAlias.html#methodbuild_uploadAccounts">nisMailAlias::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/account.html#methodbuild_uploadAccounts">account::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodbuild_uploadAccounts">inetOrgPerson::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/ieee802Device.html#methodbuild_uploadAccounts">ieee802Device::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareGroup.html#methodbuild_uploadAccounts">phpGroupwareGroup::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methodbuild_uploadAccounts">sambaAccount::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodbuild_uploadAccounts">sambaGroupMapping::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methodbuild_uploadAccounts">posixGroup::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodbuild_uploadAccounts">posixAccount::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methodbuild_uploadAccounts">kolabUser::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/ldapPublicKey.html#methodbuild_uploadAccounts">ldapPublicKey::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/inetLocalMailRecipient.html#methodbuild_uploadAccounts">inetLocalMailRecipient::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodbuild_uploadAccounts">sambaSamAccount::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/shadowAccount.html#methodbuild_uploadAccounts">shadowAccount::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html#methodbuild_uploadAccounts">phpGroupwareUser::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaDomain.html#methodbuild_uploadAccounts">sambaDomain::build_uploadAccounts()</a></dt>
<dd>In this function the LDAP account is built up.</dd>
</dl>
</p>
<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>the user input data, contains one subarray for each account.</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="methodcan_manage"></a>
<h3>method can_manage <span class="smalllinenumber">[line 397]</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 can_manage(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns true if this module can manage accounts of the current type, otherwise false.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><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 module fits</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodcheckSelfServiceOptions"></a>
<h3>method checkSelfServiceOptions <span class="smalllinenumber">[line 1216]</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 attributes which should be changed.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><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 attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array()))</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodcheckSelfServiceOptions">inetOrgPerson::checkSelfServiceOptions()</a></dt>
<dd>Checks if all input values are correct and returns the LDAP commands which should be executed.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodcheckSelfServiceOptions">posixAccount::checkSelfServiceOptions()</a></dt>
<dd>Checks if all input values are correct and returns the LDAP commands which should be executed.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methodcheckSelfServiceOptions">kolabUser::checkSelfServiceOptions()</a></dt>
<dd>Checks if all input values are correct and returns the LDAP commands which should be executed.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodcheckSelfServiceOptions">sambaSamAccount::checkSelfServiceOptions()</a></dt>
<dd>Checks if all input values are correct and returns the LDAP commands which should be executed.</dd>
</dl>
</p>
<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="methodcheckSelfServiceSettings"></a>
<h3>method checkSelfServiceSettings <span class="smalllinenumber">[line 1252]</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 checkSelfServiceSettings(
array
$options)</code>
</td></tr></table>
</td></tr></table><br />
Checks if the self service settings are valid.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> If the input data is invalid the return value is an array that contains arrays to build StatusMessages (message type, message head, message text). If no errors occured the function returns an empty array.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>error messages</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>$options</b> </td>
<td>hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.</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 670]</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 /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text'). <br />If no errors occured the function returns an empty array.</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 error messages</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/posixAccount.html#methodcheck_configOptions">posixAccount::check_configOptions()</a></dt>
<dd>Checks input values of module settings.</dd>
</dl>
</p>
<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 (option name => value) that contains the input. The option values are all arrays containing one or more elements.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodcheck_profileOptions"></a>
<h3>method check_profileOptions <span class="smalllinenumber">[line 536]</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_profileOptions(
array
$options)</code>
</td></tr></table>
</td></tr></table><br />
Checks input values of account profiles.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> $options is an hash array (option name => value) that contains the user input. The option values are all arrays containing one or more elements.<br /> If the input data is invalid the return value is an array that contains arrays to build StatusMessages (message type, message head, message text). If no errors occured the function returns an empty array.</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 error messages (array(type, title, text)) to generate StatusMessages, if any</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/quota.html#methodcheck_profileOptions">quota::check_profileOptions()</a></dt>
<dd>Checks input values of account profiles.</dd>
</dl>
</p>
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>$options</b> </td>
<td>a hash array (name => value) containing the user input</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 1054]</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 />
This function returns an array with the same syntax as save_attributes().<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> It allows additional LDAP changes when an account is deleted.</p><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>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/posixGroup.html#methoddelete_attributes">posixGroup::delete_attributes()</a></dt>
<dd>Checks if the group which should be deleted is still used as primary group.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methoddelete_attributes">posixAccount::delete_attributes()</a></dt>
<dd>Additional LDAP operations on delete.</dd>
</dl>
</p>
<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 1095]</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_attributes(
)</code>
</td></tr></table>
</td></tr></table><br />
This function creates meta HTML code to display the module page.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>HTML</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/_lib---modules.inc.html#functionparseHtml">parseHtml()</a></td>
</tr>
<tr>
<td><b>abstract:</b> </td><td></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methoddisplay_html_attributes">dhcp_settings::display_html_attributes()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/nisMailAlias.html#methoddisplay_html_attributes">nisMailAlias::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/account.html#methoddisplay_html_attributes">account::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methoddisplay_html_attributes">ddns::display_html_attributes()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html#methoddisplay_html_attributes">inetOrgPerson::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/ieee802Device.html#methoddisplay_html_attributes">ieee802Device::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareGroup.html#methoddisplay_html_attributes">phpGroupwareGroup::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methoddisplay_html_attributes">sambaAccount::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methoddisplay_html_attributes">sambaGroupMapping::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methoddisplay_html_attributes">posixGroup::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methoddisplay_html_attributes">posixAccount::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methoddisplay_html_attributes">kolabUser::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/ldapPublicKey.html#methoddisplay_html_attributes">ldapPublicKey::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/inetLocalMailRecipient.html#methoddisplay_html_attributes">inetLocalMailRecipient::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methoddisplay_html_attributes">sambaSamAccount::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/range.html#methoddisplay_html_attributes">range::display_html_attributes()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methoddisplay_html_attributes">quota::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/shadowAccount.html#methoddisplay_html_attributes">shadowAccount::display_html_attributes()</a></dt>
<dd>This function will create the meta HTML code to show a page with all attributes.</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html#methoddisplay_html_attributes">fixed_ip::display_html_attributes()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html#methoddisplay_html_attributes">phpGroupwareUser::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaDomain.html#methoddisplay_html_attributes">sambaDomain::display_html_attributes()</a></dt>
<dd>Returns the HTML meta data for the main account page.</dd>
</dl>
</p>
<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 1069]</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 />
This function creates meta HTML code which will be displayed when an account should be deleted.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> This can be used to interact with the user, e.g. should the home directory be deleted? The output of all modules is displayed on a single page.</p><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>
<tr>
<td><b>see:</b> </td><td><a href="../modules/_lib---modules.inc.html#functionparseHtml">parseHtml()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/posixAccount.html#methoddisplay_html_delete">posixAccount::display_html_delete()</a></dt>
<dd>Displays the delete homedir option for the delete page.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methoddoUploadPostActions"></a>
<h3>method doUploadPostActions <span class="smalllinenumber">[line 967]</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 is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> This function is called as long as the returned status is 'finished'. Please make sure that one function call lasts no longer than 3-4 seconds. Otherwise the upload may fail because the time limit is exceeded. You should not make more than one LDAP operation in each call.</p><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' // defines if all operations are complete <br /> 'progress' => 0..100 // the progress of the operations in percent <br /> 'errors' => array // list of arrays which are used to generate StatusMessages <br /> )</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/posixAccount.html#methoddoUploadPostActions">posixAccount::doUploadPostActions()</a></dt>
<dd>This function executes one post upload action.</dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methoddoUploadPostActions">quota::doUploadPostActions()</a></dt>
<dd>This function executes one post upload action.</dd>
</dl>
</p>
<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>maps the column names to keys for the sub arrays (array(<column_name> => <column number>))</td>
</tr>
<tr>
<td class="type">array </td>
<td><b>$failed</b> </td>
<td>list of account numbers which could not be successfully uploaded to LDAP</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="methodgetAccountContainer"></a>
<h3>method getAccountContainer <span class="smalllinenumber">[line 1264]</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><a href="../modules/accountContainer.html">accountContainer</a> getAccountContainer(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the <a href="../modules/accountContainer.html">accountContainer</a> object.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>accountContainer object</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/accountContainer.html">accountContainer</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetAttributes"></a>
<h3>method getAttributes <span class="smalllinenumber">[line 1278]</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 getAttributes(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the LDAP attributes which are managed in 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>attributes</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="methodgetButtonStatus"></a>
<h3>method getButtonStatus <span class="smalllinenumber">[line 942]</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 getButtonStatus(
)</code>
</td></tr></table>
</td></tr></table><br />
Controls if the module button the account page is visible and activated.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> <strong>Possible return values:</strong> <ul><li><strong>enabled:</strong> button is visible and active</li><li><strong>disabled:</strong> button is visible and deactivated (greyed)</li><li><strong>hidden:</strong> no button will be shown</li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>status ("enabled", "disabled", "hidden")</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/nisMailAlias.html#methodgetButtonStatus">nisMailAlias::getButtonStatus()</a></dt>
<dd>Controls if the module button the account page is visible and activated.</dd>
</dl>
<dl>
<dt><a href="../modules/account.html#methodgetButtonStatus">account::getButtonStatus()</a></dt>
<dd>Controls if the module button the account page is visible and activated.</dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodgetButtonStatus">inetOrgPerson::getButtonStatus()</a></dt>
<dd>Controls if the module button the account page is visible and activated.</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methodgetButtonStatus">posixGroup::getButtonStatus()</a></dt>
<dd>Controls if the module button the account page is visible and activated.</dd>
</dl>
<dl>
<dt><a href="../modules/range.html#methodgetButtonStatus">range::getButtonStatus()</a></dt>
<dd>Controls if the module button the account page is visible and activated.</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html#methodgetButtonStatus">fixed_ip::getButtonStatus()</a></dt>
<dd>Controls if the module button the account page is visible and activated.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIcon"></a>
<h3>method getIcon <span class="smalllinenumber">[line 1300]</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>unknown getIcon(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the path to the module icon.<br /><br /><p>The path must be releative to graphics (e.g. key.png). You can also set $this->meta['icon']. The preferred size is 32x32px.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodgetLDAPAliases"></a>
<h3>method getLDAPAliases <span class="smalllinenumber">[line 1126]</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 getLDAPAliases(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of aliases for LDAP attributes.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> All alias attributes will be renamed to the given attribute names.</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 aliases like array("alias name" => "attribute name")</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodgetManagedAttributes"></a>
<h3>method getManagedAttributes <span class="smalllinenumber">[line 1139]</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 getManagedAttributes(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of LDAP attributes which are managed by this module.<br /><br /><p>All attribute names will be renamed to match the given spelling.</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 attributes</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodgetManagedObjectClasses"></a>
<h3>method getManagedObjectClasses <span class="smalllinenumber">[line 1110]</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 getManagedObjectClasses(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of managed object classes for this module.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> This is used to fix spelling errors in LDAP-Entries (e.g. if "posixACCOUNT" is read instead of "posixAccount" from LDAP).<br /> <br /> <strong>Example:</strong> return array('posixAccount')</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 object classes</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodgetOriginalAttributes"></a>
<h3>method getOriginalAttributes <span class="smalllinenumber">[line 1287]</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 getOriginalAttributes(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the LDAP attributes which are managed in this module (with unchanged values).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>attributes</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="methodgetRequiredExtensions"></a>
<h3>method getRequiredExtensions <span class="smalllinenumber">[line 1153]</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 getRequiredExtensions(
)</code>
</td></tr></table>
</td></tr></table><br />
This function returns a list of PHP extensions (e.g. hash) which are needed by this module.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>extensions</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodgetSelfServiceFields"></a>
<h3>method getSelfServiceFields <span class="smalllinenumber">[line 1183]</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 getSelfServiceFields(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of possible input fields and their descriptions.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> <strong>Format:</strong> array(<field identifier> => <field description>)</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>fields</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodgetSelfServiceOptions"></a>
<h3>method getSelfServiceOptions <span class="smalllinenumber">[line 1202]</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>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> <strong>Format:</strong> array(<field1> => array(<META HTML>), ...)<br /> 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>
<tr>
<td><b>see:</b> </td><td><a href="../modules/_lib---modules.inc.html#functionparseHtml">parseHtml()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodgetSelfServiceOptions">inetOrgPerson::getSelfServiceOptions()</a></dt>
<dd>Returns the meta HTML code for each input field.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodgetSelfServiceOptions">posixAccount::getSelfServiceOptions()</a></dt>
<dd>Returns the meta HTML code for each input field.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methodgetSelfServiceOptions">kolabUser::getSelfServiceOptions()</a></dt>
<dd>Returns the meta HTML code for each input field.</dd>
</dl>
</p>
<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="methodgetSelfServiceSearchAttributes"></a>
<h3>method getSelfServiceSearchAttributes <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>array getSelfServiceSearchAttributes(
)</code>
</td></tr></table>
</td></tr></table><br />
This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>attributes</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodgetSelfServiceSettings"></a>
<h3>method getSelfServiceSettings <span class="smalllinenumber">[line 1235]</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 getSelfServiceSettings(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of self service configuration settings.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save settings. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.</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 code</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/_lib---modules.inc.html#functionparseHtml">parseHtml()</a></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="methodget_alias"></a>
<h3>method get_alias <span class="smalllinenumber">[line 452]</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 get_alias(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns an alias name for the module.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> This function returns a more descriptive string than the class name. Alias names are used for the buttons on the account pages and the module selection in the configuration wizard.<br /> Please take care that your alias name is not too long. It may contain any character but should not include parts that may be interpreted by the browser (e.g. '<' or '>'). If you use different aliases dependent on the account type please make sure that there is a general alias for unknown types.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>alias name</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodget_configOptions"></a>
<h3>method get_configOptions <span class="smalllinenumber">[line 647]</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_configOptions(
array
$scopes, array
$allScopes)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of configuration options.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save settings. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.</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 code</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/_lib---modules.inc.html#functionparseHtml">parseHtml()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/posixGroup.html#methodget_configOptions">posixGroup::get_configOptions()</a></dt>
<dd>Returns a list of elements for the configuration.</dd>
</dl>
</p>
<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>account types (user, group, host)</td>
</tr>
<tr>
<td class="type">array </td>
<td><b>$allScopes</b> </td>
<td>list of all active account modules and their scopes (module => array(scopes))</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodget_dependencies"></a>
<h3>method get_dependencies <span class="smalllinenumber">[line 495]</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_dependencies(
)</code>
</td></tr></table>
</td></tr></table><br />
This function returns a list with all depending and conflicting modules.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> The return value is an array with two sub arrays, "depends" and "conflicts". All values of the conflict array are string values with module names. All values of the depends array are either string values with module names or arrays which include only string values with module names.<br /> If an element of the depends array is itself an array, this means that your module depends on one of these modules.<br /> <br /> <strong>Example:</strong> return array("depends" => array("posixAccount", array("qmail", "sendmail")), "conflicts" => array("exim"))</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 dependencies and conflicts</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodget_help"></a>
<h3>method get_help <span class="smalllinenumber">[line 884]</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_help(
string
$id)</code>
</td></tr></table>
</td></tr></table><br />
This function returns the help entry array for a specific help id.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> The result is an hashtable with the following keys:<br /> <ul><li><strong>Headline (required)</strong><br />
The headline of this help entry. Can consist of any alpha-numeric characters. No HTML/CSS elements are allowed.</li><li><strong>Text (required)</strong><br />
The text of the help entry which may contain any alpha-numeric characters.</li><li><strong>SeeAlso (optional)</strong><br />
A reference to anonther related web site. It must be an array containing a field called "text" with the link text
that should be displayed and a field called "link" which is the link target.</li></ul> <br /> <strong>Example:</strong><br /> <br /> array('Headline' => 'This is the head line', 'Text' => 'Help content', 'SeeAlso' => array('text' => 'LAM homepage', 'link' => 'http://lam.sf.net'))</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The desired help entry.</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</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>$id</b> </td>
<td>The id string for the help entry needed.</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodget_ldap_filter"></a>
<h3>method get_ldap_filter <span class="smalllinenumber">[line 434]</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 get_ldap_filter(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns an LDAP filter for the account lists<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> Returns an array('or' => '...', 'and' => '...') that is used to build the LDAP filter. Usually, this is used to filter object classes. All "or" filter parts of the base modules are combined with OR and then combined with the "and" parts.<br /> The resulting LDAP filter will look like this: (&(|(OR1)(OR2)(OR3))(AND1)(AND2)(AND3))<br /> <br /> <strong>Example:</strong> return array('or' => '(objectClass=posixAccount)', 'and' => '(!(uid=*$))')</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>LDAP filter</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodget_metaData"></a>
<h3>method get_metaData <span class="smalllinenumber">[line 375]</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 />
This function provides meta data which is interpreted by baseModule.<br /><br /><p>Only subclasses will return real data.<br /> <br /> The aim of the meta data is to reduce the number of functions in the subclasses. All major data is centralized in one place.<br /> <br /> The returned array contains a list of key-value pairs for the different functions.<br /> <ul><li><strong><a href="../modules/baseModule.html#methodcan_manage">can_manage()</a></strong><br />
<br />
<strong>Key:</strong> account_types<br />
<strong>Value:</strong> array of account types<br />
<br />
<strong>Example:</strong> "account_types" => array("user", "host")
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodis_base_module">is_base_module()</a></strong><br />
<br />
<strong>Key:</strong> is_base<br />
<strong>Value:</strong> boolean<br />
<br />
<strong>Example:</strong> "is_base" => true
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodget_ldap_filter">get_ldap_filter()</a></strong><br />
<br />
<strong>Key:</strong> ldap_filter<br />
<strong>Value:</strong> array of filters<br />
<br />
<strong>Example:</strong> "ldap_filter" => array('or' => 'objectClass=posixAccount', 'and' => '(!(uid=*$))')
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodgetManagedObjectClasses">getManagedObjectClasses()</a></strong><br />
<br />
<strong>Key:</strong> objectClasses<br />
<strong>Value:</strong> array of object classes<br />
<br />
<strong>Example:</strong> "objectClasses" => array('posixAccount')
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodgetLDAPAliases">getLDAPAliases()</a></strong><br />
<br />
<strong>Key:</strong> LDAPaliases<br />
<strong>Value:</strong> array of aliases<br />
<br />
<strong>Example:</strong> "LDAPaliases" => array('commonName' => 'cn')
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodget_RDNAttributes">get_RDNAttributes()</a></strong><br />
<br />
<strong>Key:</strong> RDN<br />
<strong>Value:</strong> array of RDNs<br />
<br />
<strong>Example:</strong> "RDN" => array('uid' => 'normal', 'cn' => 'low')
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodget_dependencies">get_dependencies()</a></strong><br />
<br />
<strong>Key:</strong> dependencies<br />
<strong>Value:</strong> array of dependencies<br />
<br />
<strong>Example:</strong> "dependencies" => array("depends" => array("posixAccount", array("qmail", "sendmail")), "conflicts" => array("exim"))
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodget_profileOptions">get_profileOptions()</a></strong><br />
<br />
<strong>Key:</strong> profile_options<br />
<strong>Value:</strong> array of profile options<br />
<br />
The syntax for the value array is the same as for the return value of get_profileOptions().
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodcheck_profileOptions">check_profileOptions()</a></strong><br />
<br />
<strong>Key:</strong> profile_checks<br />
<strong>Value:</strong> array of checks (array("optionName" => array()))<br />
<br />
The "optionName" keys of the value array are the names of the option identifiers.<br />
Each array element is an array itself containing these values:
<ul><li><strong>type:</strong> determines how to check input<br />
Possible values:
<ul><li><strong>regex:</strong> check with regular expression from regex variable, case sensitive</li><li><strong>regex_i:</strong> check with regular expression from regex variable, case insensitive</li><li><strong>int_greater:</strong> integer value of cmp_name1 must be greater than the integer value from the option cmp_name2</li><li><strong>int_greaterOrEqual:</strong> integer value of cmp_name1 must be greater or equal than the integer value from the option cmp_name2</li></ul></li><li><strong>error_message:</strong> message that is displayed if input value was syntactically incorrect<br />
error_message is an array to build StatusMessages (message type, message head, message text, additional variables)</li><li><strong>regex:</strong> regular expression string (only if type is regex/regex_i)</li><li><strong>cmp_name1:</strong> name of first input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)</li><li><strong>cmp_name2:</strong> name of second input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)</li><li><strong>required:</strong> true or false, if this input field must be filled set to true (optional)</li><li><strong>required_message:</strong> message that is displayed if no input value was given (only if required == true)<br />
required_message is an array to build StatusMessages (message type, message head, message text, additional variables)</li></ul>
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodload_profile">load_profile()</a></strong><br />
<br />
<strong>Key:</strong> profile_mappings<br />
<strong>Value:</strong> array('profile_identifier1' => 'LDAP_attribute1', 'profile_identifier2' => 'LDAP_attribute2')<br />
<br />
The mapped values are stored directly in $this->attributes.
<br />
<strong>Example:</strong> "profile_mappings" => array('inetOrgPerson_title' => 'title')
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodget_configOptions">get_configOptions()</a></strong><br />
<br />
<strong>Key:</strong> config_options<br />
<strong>Value:</strong> array('user' => array, 'host' => array, 'all' => array)<br />
<br />
The values from 'all' are always returned, the other values only if they are inside the $scopes array.<br />
The syntax for sub arrays is the same as for the return value of <a href="../modules/baseModule.html#methodget_configOptions">get_configOptions()</a>.
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodcheck_configOptions">check_configOptions()</a></strong><br />
<br />
<strong>Key:</strong> config_checks<br />
<strong>Value:</strong> array('user' => array, 'host' => 'array', 'all' => array)<br />
<br />
The values from 'all' are always used for checking, the other values only if they are inside the $scopes array.
The syntax for sub arrays is the same as for <a href="../modules/baseModule.html#methodcheck_configOptions">check_configOptions()</a>.
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodget_uploadColumns">get_uploadColumns()</a></strong><br />
<br />
<strong>Key:</strong> upload_columns<br />
<strong>Value:</strong> array<br />
<br />
The syntax for array is the same as for the return value of <a href="../modules/baseModule.html#methodget_uploadColumns">get_uploadColumns()</a>.
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodget_uploadPreDepends">get_uploadPreDepends()</a></strong><br />
<br />
<strong>Key:</strong> upload_preDepends<br />
<strong>Value:</strong> array<br />
<br />
The syntax for array is the same as for the return value of <a href="../modules/baseModule.html#methodget_uploadPreDepends">get_uploadPreDepends()</a>.
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodgetRequiredExtensions">getRequiredExtensions()</a></strong><br />
<br />
<strong>Key:</strong> extensions<br />
<strong>Value:</strong> array of extension names<br />
<br />
<strong>Example:</strong> "extensions" => array('hash')
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodget_help">get_help()</a></strong><br />
<br />
<strong>Key:</strong> help<br />
<strong>Value:</strong> hashtable of help entries<br />
<br />
The hashtable is an array which maps help IDs to help entries.<br />
<br />
<strong>Example:</strong> 'help' => array('myEntry' => array('Headline' => 'This is the head line', 'Text' => 'Help content'))
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodgetSelfServiceSearchAttributes">getSelfServiceSearchAttributes()</a></strong><br />
<br />
<strong>Key:</strong> selfServiceSearchAttributes<br />
<strong>Value:</strong> array of attribute names<br />
<br />
<strong>Example:</strong> "selfServiceSearchAttributes" => array('uid')
<br /><br /></li><li><strong><a href="../modules/baseModule.html#methodgetSelfServiceFields">getSelfServiceFields()</a></strong><br />
<br />
<strong>Key:</strong> selfServiceFieldSettings<br />
<strong>Value:</strong> array of self service fields<br />
<br />
<strong>Example:</strong> "selfServiceFieldSettings" => array('pwd' => 'Password')
<br /><br /></li></ul> <strong>Example:</strong> return array("is_base" => true);</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 data</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methodget_metaData">dhcp_settings::get_metaData()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/nisMailAlias.html#methodget_metaData">nisMailAlias::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/account.html#methodget_metaData">account::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methodget_metaData">ddns::get_metaData()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodget_metaData">inetOrgPerson::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/ieee802Device.html#methodget_metaData">ieee802Device::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareGroup.html#methodget_metaData">phpGroupwareGroup::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methodget_metaData">sambaAccount::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodget_metaData">sambaGroupMapping::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methodget_metaData">posixGroup::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodget_metaData">posixAccount::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methodget_metaData">kolabUser::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/ldapPublicKey.html#methodget_metaData">ldapPublicKey::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/inetLocalMailRecipient.html#methodget_metaData">inetLocalMailRecipient::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodget_metaData">sambaSamAccount::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/range.html#methodget_metaData">range::get_metaData()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methodget_metaData">quota::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/shadowAccount.html#methodget_metaData">shadowAccount::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html#methodget_metaData">fixed_ip::get_metaData()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html#methodget_metaData">phpGroupwareUser::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
<dl>
<dt><a href="../modules/sambaDomain.html#methodget_metaData">sambaDomain::get_metaData()</a></dt>
<dd>Returns meta data that is interpreted by parent class</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodget_pdfFields"></a>
<h3>method get_pdfFields <span class="smalllinenumber">[line 794]</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_pdfFields(
string
$scope)</code>
</td></tr></table>
</td></tr></table><br />
Returns a hashtable with all entries that may be printed out in the PDF.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> This method must be overwritten in case that there are non static values to be returned. The $this->meta['PDF_fields'] array may be used for static content.<br /> <br /> <strong>Format of returned hashtable:</strong><br /> <br /> This function uses XML formatted commands to define the PDF output. Each part in the PDF document is surrounded by "<block>" and "</block>".<br /> Inside the <block> tags there are different ways to format the output: <ul><li><strong>simple line with attribute name and value:</strong> <block><key><strong>attribute name</strong></key><value><strong>attribute value</strong></value></block></li><li><strong>table:</strong> <block><key><strong>attribute name</strong></key><tr><td><strong>value</strong><td><td><strong>value</strong><td></tr></block><block><tr><td><strong>value</strong></td><td><strong>value</strong><td></tr></block></li></ul> <strong>Special commands:</strong> <ul><li><strong>Alignment in <td>:</strong> You can specify the alignment in <td> tags with align=(L|R|C) (e.g. <td align=\"L\">)</li><li><strong>Cell width:</strong> <td> allows an attribute "width" to set the cell width (e.g. <td width=20%> or <td width=30>).</li><li><strong>Line breaks:</strong> Line breaks can be specified by adding a <br> tag. The new line will start at the left border of the PDF document.</li></ul> <br /> <strong>Examples:</strong><br /> <br /> <strong>Simple name+value lines:</strong><br /><br /> In most cases you will just want to display a single line per attribute with its name and value.<br /> <br /> 'myAttribute' => '<block><key>AttrName</key><value>12345</value></block>'<br /> <br /> This will give the following PDF output:<br /> <br /> <strong>Attribute name:</strong> 12345<br /> <br /> <br /> <strong>Multiline values:</strong><br /><br /> Sometimes you have multivalued attributes where it is not applicable to write all values in one line but where you want to list your values one below the other or show a table. This can be done by using the <td> tag.<br /> <br /> This example only uses one column but you can just use more <td> tags per <block> tag to display more columns.<br /> <br /> 'myAttribute' => '<block><key>AttrName</key><tr><td align=\"L\">123</td></tr></block><block><tr><td align=\"L\">456</td></tr></block><block><tr><td align=\"L\">789</td></tr></block>'</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>PDF entries</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</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>$scope</b> </td>
<td>account type</td>
</tr>
</table>
</div><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 515]</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_profileOptions(
)</code>
</td></tr></table>
</td></tr></table><br />
This function defines what attributes will be used in the account profiles and their appearance in the profile editor.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> The return value is an array that contains meta HTML code.<br /> The type "fieldset" is not allowed here. The name attributes are used as keywords to load and save profiles. We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.</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 code</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/_lib---modules.inc.html#functionparseHtml">parseHtml()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methodget_profileOptions">dhcp_settings::get_profileOptions()</a></dt>
<dd>Returns a list of elements for the account profiles.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methodget_profileOptions">ddns::get_profileOptions()</a></dt>
<dd>Returns a list of elements for the account profiles.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodget_profileOptions">sambaGroupMapping::get_profileOptions()</a></dt>
<dd>Returns a list of elements for the account profiles.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodget_profileOptions">posixAccount::get_profileOptions()</a></dt>
<dd>Returns a list of elements for the account profiles.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodget_profileOptions">sambaSamAccount::get_profileOptions()</a></dt>
<dd>Returns a list of elements for the account profiles.</dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methodget_profileOptions">quota::get_profileOptions()</a></dt>
<dd>Returns a list of elements for the account profiles.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodget_RDNAttributes"></a>
<h3>method get_RDNAttributes <span class="smalllinenumber">[line 472]</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_RDNAttributes(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> The returned elements have this form: <attribute> => <priority> <br /> <attribute> is the name of the LDAP attribute <br /> <priority> defines the priority of the attribute (can be "low", "normal", "high")<br /> <br /> <strong>Example:</strong> return array('uid' => 'normal', 'cn' => 'low')</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 attributes</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodget_scope"></a>
<h3>method get_scope <span class="smalllinenumber">[line 384]</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 get_scope(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the account type of this module (user, group, host)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>account type</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="methodget_uploadColumns"></a>
<h3>method get_uploadColumns <span class="smalllinenumber">[line 821]</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_uploadColumns(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns an array containing all input columns for the file upload.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> This funtion returns an array which contains subarrays which represent an upload column. <strong>Syntax of column arrays:</strong> <br /> <br /> array( <br /> string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>) <br /> string: description, // short descriptive name <br /> string: help, // help ID <br /> string: example, // example value <br /> string: values, // possible input values (optional) <br /> string: default, // default value (optional) <br /> boolean: required // true, if user must set a value for this column <br /> boolean: unique // true if all values of this column must be different values (optional, default: "false") <br /> )</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>column list</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/quota.html#methodget_uploadColumns">quota::get_uploadColumns()</a></dt>
<dd>Returns an array containing all input columns for the file upload.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodget_uploadPreDepends"></a>
<h3>method get_uploadPreDepends <span class="smalllinenumber">[line 837]</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_uploadPreDepends(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns a list of module names which must be processed in building the account befor this module.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> The named modules may not be active, LAM will check this automatically.</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 module names</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodinit"></a>
<h3>method init <span class="smalllinenumber">[line 112]</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 <a href="../modules/accountContainer.html">accountContainer</a><br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/sambaAccount.html#methodinit">sambaAccount::init()</a></dt>
<dd>Initializes the module after it became part of an accountContainer</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodinit">sambaGroupMapping::init()</a></dt>
<dd>Initializes the module after it became part of an accountContainer</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methodinit">posixGroup::init()</a></dt>
<dd>This functin will be called when the module will be loaded *</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodinit">posixAccount::init()</a></dt>
<dd>Initializes the module after it became part of an accountContainer</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodinit">sambaSamAccount::init()</a></dt>
<dd>Initializes the module after it became part of an accountContainer</dd>
</dl>
</p>
<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 <a href="../modules/accountContainer.html">accountContainer</a> object ($_SESSION[$base])</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodis_base_module"></a>
<h3>method is_base_module <span class="smalllinenumber">[line 414]</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 is_base_module(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns true if your module is a base module and otherwise false.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> Every account type needs exactly one base module. A base module manages a structural object class. E.g. the inetOrgPerson module is a base module since its object class is structural.</p><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 base module (defaults to false if no meta data is provided)</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></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="methodload_attributes"></a>
<h3>method load_attributes <span class="smalllinenumber">[line 140]</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
$attributes)</code>
</td></tr></table>
</td></tr></table><br />
This function loads the LDAP attributes when an account should be loaded.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> By default this method loads the object classes and accounts which are specified in <a href="../modules/baseModule.html#methodgetManagedObjectClasses">getManagedObjectClasses()</a> and <a href="../modules/baseModule.html#methodgetManagedAttributes">getManagedAttributes()</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methodload_attributes">dhcp_settings::load_attributes()</a></dt>
<dd>This function loads all needed LDAP attributes.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methodload_attributes">ddns::load_attributes()</a></dt>
<dd>This function loads all needed LDAP attributes.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methodload_attributes">sambaAccount::load_attributes()</a></dt>
<dd>This function loads the LDAP attributes for this module.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodload_attributes">posixAccount::load_attributes()</a></dt>
<dd>This function loads all needed LDAP attributes.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodload_attributes">sambaSamAccount::load_attributes()</a></dt>
<dd>This function loads the LDAP attributes for this module.</dd>
</dl>
<dl>
<dt><a href="../modules/range.html#methodload_attributes">range::load_attributes()</a></dt>
<dd>This function loads all needed LDAP attributes.</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html#methodload_attributes">fixed_ip::load_attributes()</a></dt>
<dd>This function loads all needed LDAP attributes.</dd>
</dl>
</p>
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>$attributes</b> </td>
<td>array like the array returned by get_ldap_attributes(dn of account) but without count indices</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 102]</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 $messages variable with output messages from this module.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>protected</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methodload_Messages">dhcp_settings::load_Messages()</a></dt>
<dd>This function fills the message array.</dd>
</dl>
<dl>
<dt><a href="../modules/nisMailAlias.html#methodload_Messages">nisMailAlias::load_Messages()</a></dt>
<dd>This function fills the error message array with messages</dd>
</dl>
<dl>
<dt><a href="../modules/account.html#methodload_Messages">account::load_Messages()</a></dt>
<dd>This function fills the message array.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methodload_Messages">ddns::load_Messages()</a></dt>
<dd>This function fills the message array.</dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodload_Messages">inetOrgPerson::load_Messages()</a></dt>
<dd>This function fills the message array.</dd>
</dl>
<dl>
<dt><a href="../modules/ieee802Device.html#methodload_Messages">ieee802Device::load_Messages()</a></dt>
<dd>This function fills the error message array with messages</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methodload_Messages">sambaAccount::load_Messages()</a></dt>
<dd>this functin fills the error message array with messages</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodload_Messages">sambaGroupMapping::load_Messages()</a></dt>
<dd>this functin fills the error message array with messages</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methodload_Messages">posixGroup::load_Messages()</a></dt>
<dd>This function fills the $messages variable with output messages from this module.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodload_Messages">posixAccount::load_Messages()</a></dt>
<dd>This function fills the error message array with messages.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methodload_Messages">kolabUser::load_Messages()</a></dt>
<dd>This function fills the error message array with messages</dd>
</dl>
<dl>
<dt><a href="../modules/inetLocalMailRecipient.html#methodload_Messages">inetLocalMailRecipient::load_Messages()</a></dt>
<dd>This function fills the error message array with messages</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodload_Messages">sambaSamAccount::load_Messages()</a></dt>
<dd>this functin fills the error message array with messages</dd>
</dl>
<dl>
<dt><a href="../modules/range.html#methodload_Messages">range::load_Messages()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methodload_Messages">quota::load_Messages()</a></dt>
<dd>this functin fills the error message array with messages</dd>
</dl>
<dl>
<dt><a href="../modules/shadowAccount.html#methodload_Messages">shadowAccount::load_Messages()</a></dt>
<dd>This function builds up the message array.</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html#methodload_Messages">fixed_ip::load_Messages()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html#methodload_Messages">phpGroupwareUser::load_Messages()</a></dt>
<dd>This function builds up the message array.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaDomain.html#methodload_Messages">sambaDomain::load_Messages()</a></dt>
<dd>This function fills the error message array with messages</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodload_profile"></a>
<h3>method load_profile <span class="smalllinenumber">[line 621]</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 />
This function loads the values from an account profile to the module's internal data structures.<br /><br /><p>Calling this method does not require the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methodload_profile">dhcp_settings::load_profile()</a></dt>
<dd>Loads the values of an account profile into internal variables.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methodload_profile">ddns::load_profile()</a></dt>
<dd>TODO !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Loads the values of an account profile into internal variables.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methodload_profile">sambaAccount::load_profile()</a></dt>
<dd>Loads the values of an account profile into internal variables.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodload_profile">sambaGroupMapping::load_profile()</a></dt>
<dd>Loads the values of an account profile into internal variables.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodload_profile">posixAccount::load_profile()</a></dt>
<dd>Loads the values of an account profile into internal variables.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodload_profile">sambaSamAccount::load_profile()</a></dt>
<dd>Loads the values of an account profile into internal variables.</dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methodload_profile">quota::load_profile()</a></dt>
<dd>Loads the values of an account profile into internal variables.</dd>
</dl>
<dl>
<dt><a href="../modules/shadowAccount.html#methodload_profile">shadowAccount::load_profile()</a></dt>
<dd>Loads the values of an account profile into internal variables.</dd>
</dl>
</p>
<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 924]</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 /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> This function tells LAM if it can create/modify the LDAP account. If your module needs any additional input then set this to false. The user will be notified that your module needs more input.<br /> This method's return value defaults to true.</p><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>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methodmodule_complete">dhcp_settings::module_complete()</a></dt>
<dd>This functions returns true if all needed settings are done.</dd>
</dl>
<dl>
<dt><a href="../modules/account.html#methodmodule_complete">account::module_complete()</a></dt>
<dd>This functions returns true if all needed settings are done.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methodmodule_complete">ddns::module_complete()</a></dt>
<dd>This functions returns true if all needed settings are done.</dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodmodule_complete">inetOrgPerson::module_complete()</a></dt>
<dd>This functions return true if all needed settings are done.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methodmodule_complete">sambaAccount::module_complete()</a></dt>
<dd>This functions returns true if all needed settings are done</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methodmodule_complete">posixGroup::module_complete()</a></dt>
<dd>This functions is used to check if all settings for this module have been made.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodmodule_complete">posixAccount::module_complete()</a></dt>
<dd>This functions is used to check if all settings for this module have been made.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methodmodule_complete">kolabUser::module_complete()</a></dt>
<dd>This function returns true if all needed settings are done.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodmodule_ready"></a>
<h3>method module_ready <span class="smalllinenumber">[line 908]</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_ready(
)</code>
</td></tr></table>
</td></tr></table><br />
This function is used to check if this module page can be displayed.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> Your module might depend on input of other modules. This function determines if the user can change to your module page or not. The return value is true if your module accepts input, otherwise false.<br /> This method's return value defaults to true.</p><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 page can be displayed</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/sambaAccount.html#methodmodule_ready">sambaAccount::module_ready()</a></dt>
<dd>This function is used to check if this module page can be displayed.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodmodule_ready">sambaGroupMapping::module_ready()</a></dt>
<dd>This function is used to check if this module page can be displayed.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodmodule_ready">sambaSamAccount::module_ready()</a></dt>
<dd>This function is used to check if this module page can be displayed.</dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methodmodule_ready">quota::module_ready()</a></dt>
<dd>This function is used to check if this module page can be displayed.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodpostDeleteActions"></a>
<h3>method postDeleteActions <span class="smalllinenumber">[line 1041]</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 postDeleteActions(
)</code>
</td></tr></table>
</td></tr></table><br />
Allows the module to run commands after the LDAP entry is deleted.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<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="methodpostModifyActions"></a>
<h3>method postModifyActions <span class="smalllinenumber">[line 1019]</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 is changed or created.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/phpGroupwareGroup.html#methodpostModifyActions">phpGroupwareGroup::postModifyActions()</a></dt>
<dd>Allows the module to run commands after the LDAP entry is changed or created.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodpostModifyActions">posixAccount::postModifyActions()</a></dt>
<dd>Allows the module to run commands after the LDAP entry was changed or created.</dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methodpostModifyActions">quota::postModifyActions()</a></dt>
<dd>Allows the module to run commands after the LDAP entry is changed or created.</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html#methodpostModifyActions">fixed_ip::postModifyActions()</a></dt>
<dd>This function will be overwrite, because this function creates the fixed ips after ldap_add command.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html#methodpostModifyActions">phpGroupwareUser::postModifyActions()</a></dt>
<dd>Allows the module to run commands after the LDAP entry is changed or created.</dd>
</dl>
</p>
<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 1032]</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>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> 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>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/posixAccount.html#methodpreDeleteActions">posixAccount::preDeleteActions()</a></dt>
<dd>Allows the module to run commands before the LDAP entry is deleted.</dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methodpreDeleteActions">quota::preDeleteActions()</a></dt>
<dd>Allows the module to run commands before the LDAP entry is deleted.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodpreModifyActions"></a>
<h3>method preModifyActions <span class="smalllinenumber">[line 1008]</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, preModifyActions(
boolean
$newAccount)</code>
</td></tr></table>
</td></tr></table><br />
Allows the module to run commands before the LDAP entry is changed or created.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> 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>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<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="methodprocess_attributes"></a>
<h3>method process_attributes <span class="smalllinenumber">[line 1084]</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 />
This function processes user input.<br /><br /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /> It checks the user input and saves changes in the module's data structures.<br /> <br /> <strong>Example:</strong> return array(array('ERROR', 'Invalid input!', 'This is not allowed here.'));</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Array which contains status messages. Each entry is an array containing the status message parameters.</td>
</tr>
<tr>
<td><b>abstract:</b> </td><td></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methodprocess_attributes">dhcp_settings::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/nisMailAlias.html#methodprocess_attributes">nisMailAlias::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/account.html#methodprocess_attributes">account::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methodprocess_attributes">ddns::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodprocess_attributes">inetOrgPerson::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/ieee802Device.html#methodprocess_attributes">ieee802Device::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareGroup.html#methodprocess_attributes">phpGroupwareGroup::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methodprocess_attributes">sambaAccount::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodprocess_attributes">sambaGroupMapping::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methodprocess_attributes">posixGroup::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodprocess_attributes">posixAccount::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methodprocess_attributes">kolabUser::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/ldapPublicKey.html#methodprocess_attributes">ldapPublicKey::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/inetLocalMailRecipient.html#methodprocess_attributes">inetLocalMailRecipient::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodprocess_attributes">sambaSamAccount::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/range.html#methodprocess_attributes">range::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/quota.html#methodprocess_attributes">quota::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/shadowAccount.html#methodprocess_attributes">shadowAccount::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html#methodprocess_attributes">fixed_ip::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html#methodprocess_attributes">phpGroupwareUser::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaDomain.html#methodprocess_attributes">sambaDomain::process_attributes()</a></dt>
<dd>Processes user input of the primary module page.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsave_attributes"></a>
<h3>method save_attributes <span class="smalllinenumber">[line 994]</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 /><p>Calling this method requires the existence of an enclosing <a href="../modules/accountContainer.html">accountContainer</a>.<br /> <br /></p><p><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 is possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)<br /> <br /><strong>"add"</strong> are attributes which have to be added to the LDAP entry <br /><strong>"remove"</strong> are attributes which have to be removed from the LDAP entry <br /><strong>"modify"</strong> are attributes which have to be modified in the LDAP entry <br /><strong>"notchanged"</strong> are attributes which stay unchanged <br /> <br />This builds the required comands from $this-attributes and $this->orig.</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 modifications</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../modules/dhcp_settings.html#methodsave_attributes">dhcp_settings::save_attributes()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/nisMailAlias.html#methodsave_attributes">nisMailAlias::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/account.html#methodsave_attributes">account::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/ddns.html#methodsave_attributes">ddns::save_attributes()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/inetOrgPerson.html#methodsave_attributes">inetOrgPerson::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareGroup.html#methodsave_attributes">phpGroupwareGroup::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaAccount.html#methodsave_attributes">sambaAccount::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaGroupMapping.html#methodsave_attributes">sambaGroupMapping::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/posixGroup.html#methodsave_attributes">posixGroup::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/posixAccount.html#methodsave_attributes">posixAccount::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/kolabUser.html#methodsave_attributes">kolabUser::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/sambaSamAccount.html#methodsave_attributes">sambaSamAccount::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/range.html#methodsave_attributes">range::save_attributes()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/shadowAccount.html#methodsave_attributes">shadowAccount::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
<dl>
<dt><a href="../modules/fixed_ip.html#methodsave_attributes">fixed_ip::save_attributes()</a></dt>
<dd></dd>
</dl>
<dl>
<dt><a href="../modules/phpGroupwareUser.html#methodsave_attributes">phpGroupwareUser::save_attributes()</a></dt>
<dd>Returns a list of modifications which have to be made to the LDAP account.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
<div class="credit">
<hr />
Documentation generated on Mon, 13 Oct 2008 21:03:43 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
50a8f54faec0937919ad812d86f5c9d8
>
files
>
260
