753 lines
26 KiB
HTML
753 lines
26 KiB
HTML
<html>
|
|
<head>
|
|
<title>Docs For Class nisMailAlias</title>
|
|
<link rel="stylesheet" type="text/css" href="../media/style.css">
|
|
</head>
|
|
<body>
|
|
|
|
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
|
|
<tr>
|
|
<td class="header_top">modules</td>
|
|
</tr>
|
|
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
|
|
<tr>
|
|
<td class="header_menu">
|
|
|
|
|
|
[ <a href="../classtrees_modules.html" class="menu">class tree: modules</a> ]
|
|
[ <a href="../elementindex_modules.html" class="menu">index: modules</a> ]
|
|
[ <a href="../elementindex.html" class="menu">all elements</a> ]
|
|
</td>
|
|
</tr>
|
|
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
|
|
</table>
|
|
|
|
<table width="100%" border="0" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="200" class="menu">
|
|
<div id="ric">
|
|
<p><a href="../ric_INSTALL.html">INSTALL</a></p>
|
|
<p><a href="../ric_README.html">README</a></p>
|
|
</div>
|
|
<b>Packages:</b><br />
|
|
<a href="../li_configuration.html">configuration</a><br />
|
|
<a href="../li_Help.html">Help</a><br />
|
|
<a href="../li_LDAP.html">LDAP</a><br />
|
|
<a href="../li_lib.html">lib</a><br />
|
|
<a href="../li_lists.html">lists</a><br />
|
|
<a href="../li_main.html">main</a><br />
|
|
<a href="../li_modules.html">modules</a><br />
|
|
<a href="../li_PDF.html">PDF</a><br />
|
|
<a href="../li_profiles.html">profiles</a><br />
|
|
<a href="../li_selfService.html">selfService</a><br />
|
|
<a href="../li_tests.html">tests</a><br />
|
|
<a href="../li_tools.html">tools</a><br />
|
|
<a href="../li_types.html">types</a><br />
|
|
<br /><br />
|
|
<b>Files:</b><br />
|
|
<div class="package">
|
|
<a href="../modules/_lib---modules---account.inc.html"> account.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---baseModule.inc.html"> baseModule.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---createntlm.inc.html"> createntlm.inc
|
|
</a><br>
|
|
<a href="../modules/_templates---account---edit.php.html"> edit.php
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---ieee802device.inc.html"> ieee802device.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---inetLocalMailRecipient.inc.html"> inetLocalMailRecipient.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---inetOrgPerson.inc.html"> inetOrgPerson.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---kolabUser.inc.html"> kolabUser.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---lamdaemon.inc.html"> lamdaemon.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---ldapPublicKey.inc.html"> ldapPublicKey.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules.inc.html"> modules.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---nisMailAlias.inc.html"> nisMailAlias.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---posixAccount.inc.html"> posixAccount.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---posixGroup.inc.html"> posixGroup.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---quota.inc.html"> quota.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaAccount.inc.html"> sambaAccount.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaDomain.inc.html"> sambaDomain.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaGroupMapping.inc.html"> sambaGroupMapping.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaSamAccount---sambaMungedDial.inc.html"> sambaMungedDial.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---sambaSamAccount.inc.html"> sambaSamAccount.inc
|
|
</a><br>
|
|
<a href="../modules/_lib---modules---shadowAccount.inc.html"> shadowAccount.inc
|
|
</a><br>
|
|
</div><br />
|
|
|
|
|
|
|
|
<b>Classes:</b><br />
|
|
<div class="package">
|
|
<a href="../modules/account.html">account</a><br />
|
|
<a href="../modules/accountContainer.html">accountContainer</a><br />
|
|
<a href="../modules/baseModule.html">baseModule</a><br />
|
|
<a href="../modules/ieee802Device.html">ieee802Device</a><br />
|
|
<a href="../modules/inetLocalMailRecipient.html">inetLocalMailRecipient</a><br />
|
|
<a href="../modules/inetOrgPerson.html">inetOrgPerson</a><br />
|
|
<a href="../modules/kolabUser.html">kolabUser</a><br />
|
|
<a href="../modules/ldapPublicKey.html">ldapPublicKey</a><br />
|
|
<a href="../modules/nisMailAlias.html">nisMailAlias</a><br />
|
|
<a href="../modules/posixAccount.html">posixAccount</a><br />
|
|
<a href="../modules/posixGroup.html">posixGroup</a><br />
|
|
<a href="../modules/quota.html">quota</a><br />
|
|
<a href="../modules/samba3domain.html">samba3domain</a><br />
|
|
<a href="../modules/sambaAccount.html">sambaAccount</a><br />
|
|
<a href="../modules/sambaDomain.html">sambaDomain</a><br />
|
|
<a href="../modules/sambaGroupMapping.html">sambaGroupMapping</a><br />
|
|
<a href="../modules/sambaMungedDial.html">sambaMungedDial</a><br />
|
|
<a href="../modules/sambaSamAccount.html">sambaSamAccount</a><br />
|
|
<a href="../modules/shadowAccount.html">shadowAccount</a><br />
|
|
<a href="../modules/smbHash.html">smbHash</a><br />
|
|
</div>
|
|
|
|
</td>
|
|
<td>
|
|
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
|
|
|
|
<h1>Class: nisMailAlias</h1>
|
|
Source Location: /lib/modules/nisMailAlias.inc<br /><br />
|
|
|
|
|
|
<table width="100%" border="0">
|
|
<tr><td valign="top">
|
|
|
|
<h3><a href="#class_details">Class Overview</a></h3>
|
|
<pre><a href="../modules/baseModule.html">baseModule</a>
|
|
|
|
|
--nisMailAlias</pre><br />
|
|
<div class="description">Provides NIS mail alias management.</div><br /><br />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td valign="top">
|
|
<h3><a href="#class_methods">Methods</a></h3>
|
|
<ul>
|
|
<li><a href="../modules/nisMailAlias.html#methodbuild_uploadAccounts">build_uploadAccounts</a></li>
|
|
<li><a href="../modules/nisMailAlias.html#methoddisplay_html_attributes">display_html_attributes</a></li>
|
|
<li><a href="../modules/nisMailAlias.html#methodgetButtonStatus">getButtonStatus</a></li>
|
|
<li><a href="../modules/nisMailAlias.html#methodget_metaData">get_metaData</a></li>
|
|
<li><a href="../modules/nisMailAlias.html#methodget_pdfEntries">get_pdfEntries</a></li>
|
|
<li><a href="../modules/nisMailAlias.html#methodload_Messages">load_Messages</a></li>
|
|
<li><a href="../modules/nisMailAlias.html#methodprocess_attributes">process_attributes</a></li>
|
|
<li><a href="../modules/nisMailAlias.html#methodsave_attributes">save_attributes</a></li>
|
|
</ul>
|
|
</td>
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<table width="100%" border="0"><tr>
|
|
|
|
|
|
|
|
|
|
<td valign="top">
|
|
<h3>Inherited Variables</h3>
|
|
<div class="tags">
|
|
<h4>Class: <a href="../modules/baseModule.html">baseModule</a></h4>
|
|
<dl>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$attributes">baseModule::$attributes</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$messages">baseModule::$messages</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$meta">baseModule::$meta</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$moduleSettings">baseModule::$moduleSettings</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$orig">baseModule::$orig</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#var$selfServiceSettings">baseModule::$selfServiceSettings</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</td>
|
|
|
|
<td valign="top">
|
|
<h3>Inherited Methods</h3>
|
|
<div class="tags">
|
|
<h4>Class: <a href="../modules/baseModule.html">baseModule</a></h4>
|
|
<dl>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodbaseModule">baseModule::baseModule()</a>
|
|
</dt>
|
|
<dd>
|
|
Creates a new base module class
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodbuild_uploadAccounts">baseModule::build_uploadAccounts()</a>
|
|
</dt>
|
|
<dd>
|
|
In this function the LDAP account is built up.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcan_manage">baseModule::can_manage()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns true if this module fits for the current scope.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcheckSelfServiceOptions">baseModule::checkSelfServiceOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Checks if all input values are correct and returns the LDAP commands which should be executed.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcheckSelfServiceSettings">baseModule::checkSelfServiceSettings()</a>
|
|
</dt>
|
|
<dd>
|
|
Checks if the self service settings are valid.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcheck_configOptions">baseModule::check_configOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Checks input values of module settings.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodcheck_profileOptions">baseModule::check_profileOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Checks input values of account profiles.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methoddelete_attributes">baseModule::delete_attributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Dummy function for modules which use no special options on account deletion.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methoddisplay_html_delete">baseModule::display_html_delete()</a>
|
|
</dt>
|
|
<dd>
|
|
Dummy function for modules which do not print extra HTML code on account deletion.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methoddoUploadPostActions">baseModule::doUploadPostActions()</a>
|
|
</dt>
|
|
<dd>
|
|
This function executes one post upload action.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetAccountContainer">baseModule::getAccountContainer()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the accountContainer object.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetAttributes">baseModule::getAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the LDAP attributes which are managed in this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetButtonStatus">baseModule::getButtonStatus()</a>
|
|
</dt>
|
|
<dd>
|
|
Controls if the module button the account page is visible and activated.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetLDAPAliases">baseModule::getLDAPAliases()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of aliases for LDAP attributes.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetManagedAttributes">baseModule::getManagedAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of LDAP attributes which are managed by this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetManagedObjectClasses">baseModule::getManagedObjectClasses()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of managed object classes for this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetOriginalAttributes">baseModule::getOriginalAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the LDAP attributes which are managed in this module (with unchanged values).
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetRequiredExtensions">baseModule::getRequiredExtensions()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of required PHP extensions.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetSelfServiceFields">baseModule::getSelfServiceFields()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of possible input fields and their descriptions Format: array(<field identifier> => <field description>)
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetSelfServiceOptions">baseModule::getSelfServiceOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the meta HTML code for each input field.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetSelfServiceSearchAttributes">baseModule::getSelfServiceSearchAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of possible search attributes for the self service.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodgetSelfServiceSettings">baseModule::getSelfServiceSettings()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of self service configuration settings.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_alias">baseModule::get_alias()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns an alias name for the module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_configOptions">baseModule::get_configOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of elements for the configuration.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_dependencies">baseModule::get_dependencies()</a>
|
|
</dt>
|
|
<dd>
|
|
This function returns a list with all depending and conflicting modules.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_help">baseModule::get_help()</a>
|
|
</dt>
|
|
<dd>
|
|
This function return the help entry array for a specific help id. Normally this->meta can be used.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_ldap_filter">baseModule::get_ldap_filter()</a>
|
|
</dt>
|
|
<dd>
|
|
returns an LDAP filter for the account lists
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a>
|
|
</dt>
|
|
<dd>
|
|
Dummy function, meta data is provided by sub classes.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_pdfFields">baseModule::get_pdfFields()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns an array with all fields available for this account type on the PDF output. This method may be overwritten by subclasses or it may be used by using entries in the $this->meta['PDF_fields'] array of the specific sub- class.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_pdf_entries">baseModule::get_pdf_entries()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a hastable with all entries that may be printed out in the PDF. The
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_profileOptions">baseModule::get_profileOptions()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of elements for the account profiles.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_RDNAttributes">baseModule::get_RDNAttributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of possible LDAP attributes which can be used to form the RDN.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_scope">baseModule::get_scope()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns the account type of this module (user, group, host)
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_uploadColumns">baseModule::get_uploadColumns()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns an array containing all input columns for the file upload.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodget_uploadPreDepends">baseModule::get_uploadPreDepends()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of module names which must be processed in building the account befor this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodinit">baseModule::init()</a>
|
|
</dt>
|
|
<dd>
|
|
Initializes the module after it became part of an accountContainer
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodis_base_module">baseModule::is_base_module()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns true if this module is enough to provide a sensible account.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodload_attributes">baseModule::load_attributes()</a>
|
|
</dt>
|
|
<dd>
|
|
This function loads the LDAP attributes for this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodload_Messages">baseModule::load_Messages()</a>
|
|
</dt>
|
|
<dd>
|
|
This function fills the $messages variable with output messages from this module.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodload_profile">baseModule::load_profile()</a>
|
|
</dt>
|
|
<dd>
|
|
Loads the values of an account profile into internal variables.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodmodule_complete">baseModule::module_complete()</a>
|
|
</dt>
|
|
<dd>
|
|
This functions is used to check if all settings for this module have been made.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodmodule_ready">baseModule::module_ready()</a>
|
|
</dt>
|
|
<dd>
|
|
This function is used to check if this module page can be displayed.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodpostDeleteActions">baseModule::postDeleteActions()</a>
|
|
</dt>
|
|
<dd>
|
|
Allows the module to run commands after the LDAP entry is deleted.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodpostModifyActions">baseModule::postModifyActions()</a>
|
|
</dt>
|
|
<dd>
|
|
Allows the module to run commands after the LDAP entry is changed or created.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodpreDeleteActions">baseModule::preDeleteActions()</a>
|
|
</dt>
|
|
<dd>
|
|
Allows the module to run commands before the LDAP entry is deleted.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodpreModifyActions">baseModule::preModifyActions()</a>
|
|
</dt>
|
|
<dd>
|
|
Allows the module to run commands before the LDAP entry is changed or created.
|
|
</dd>
|
|
<dt>
|
|
<a href="../modules/baseModule.html#methodsave_attributes">baseModule::save_attributes()</a>
|
|
</dt>
|
|
<dd>
|
|
Returns a list of modifications which have to be made to the LDAP account.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</td>
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<a name="class_details"></a>
|
|
<h3>Class Details</h3>
|
|
<div class="tags">
|
|
[line 35]<br />
|
|
Provides NIS mail alias management.<br /><br /></div><br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
|
|
|
|
|
<hr />
|
|
<a name="class_methods"></a>
|
|
<h3>Class Methods</h3>
|
|
<div class="tags">
|
|
|
|
<hr />
|
|
<a name="methodbuild_uploadAccounts"></a>
|
|
<h3>method build_uploadAccounts <span class="smalllinenumber">[line 230]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array build_uploadAccounts(
|
|
array
|
|
$rawAccounts, array
|
|
$ids,
|
|
&$partialAccounts, array
|
|
$partialAccounts)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
In this function the LDAP account is built up.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of error messages if any</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodbuild_uploadAccounts">baseModule::build_uploadAccounts()</a> (In this function the LDAP account is built up.)<br /><br />
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$rawAccounts</b> </td>
|
|
<td>list of hash arrays (name => value) from user input</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$partialAccounts</b> </td>
|
|
<td>list of hash arrays (name => value) which are later added to LDAP</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">array </td>
|
|
<td><b>$ids</b> </td>
|
|
<td>list of IDs for column position (e.g. "posixAccount_uid" => 5)</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type"> </td>
|
|
<td><b>&$partialAccounts</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methoddisplay_html_attributes"></a>
|
|
<h3>method display_html_attributes <span class="smalllinenumber">[line 131]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array display_html_attributes(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the HTML meta data for the main account page.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>HTML meta data</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetButtonStatus"></a>
|
|
<h3>method getButtonStatus <span class="smalllinenumber">[line 211]</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 /><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>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodgetButtonStatus">baseModule::getButtonStatus()</a> (Controls if the module button the account page is visible and activated.)<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 42]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array get_metaData(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns meta data that is interpreted by parent class<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>array with meta data</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a> (Dummy function, meta data is provided by sub classes.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodget_pdfEntries"></a>
|
|
<h3>method get_pdfEntries <span class="smalllinenumber">[line 269]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array get_pdfEntries(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the PDF entries for this module.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of possible PDF entries</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodload_Messages"></a>
|
|
<h3>method load_Messages <span class="smalllinenumber">[line 100]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>void load_Messages(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
This function fills the error message array with messages<br /><br /><br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodload_Messages">baseModule::load_Messages()</a> (This function fills the $messages variable with output messages from this module.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodprocess_attributes"></a>
|
|
<h3>method process_attributes <span class="smalllinenumber">[line 162]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array process_attributes(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Processes user input of the primary module page.<br /><br /><p>It checks if all input values are correct and updates the associated LDAP attributes.</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of info/error messages</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodsave_attributes"></a>
|
|
<h3>method save_attributes <span class="smalllinenumber">[line 118]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>array save_attributes(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns a list of modifications which have to be made to the LDAP account.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>list of modifications <br />This function returns an array with 3 entries: <br />array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br />DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br />"add" are attributes which have to be added to LDAP entry <br />"remove" are attributes which have to be removed from LDAP entry <br />"modify" are attributes which have to been modified in LDAP entry</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
Overrides <a href="../modules/baseModule.html#methodsave_attributes">baseModule::save_attributes()</a> (Returns a list of modifications which have to be made to the LDAP account.)<br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
</div><br />
|
|
|
|
|
|
<div class="credit">
|
|
<hr />
|
|
Documentation generated on Sun, 04 Nov 2007 12:10:58 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
|
|
</div>
|
|
</td></tr></table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html> |