<html> <head> <title>Docs For Class accountContainer</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: accountContainer</h1> Source Location: /lib/modules.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">This class includes all modules and attributes of an account.</div><br /><br /> </td> <td valign="top"> <h3><a href="#class_vars">Variables</a></h3> <ul> <li><a href="../modules/accountContainer.html#var$attributes">$attributes</a></li> <li><a href="../modules/accountContainer.html#var$attributes_orig">$attributes_orig</a></li> <li><a href="../modules/accountContainer.html#var$dn">$dn</a></li> <li><a href="../modules/accountContainer.html#var$dn_orig">$dn_orig</a></li> <li><a href="../modules/accountContainer.html#var$isNewAccount">$isNewAccount</a></li> <li><a href="../modules/accountContainer.html#var$rdn">$rdn</a></li> </ul> </td> <td valign="top"> <h3><a href="#class_methods">Methods</a></h3> <ul> <li><a href="../modules/accountContainer.html#method__construct">__construct</a></li> <li><a href="../modules/accountContainer.html#methodcontinue_main">continue_main</a></li> <li><a href="../modules/accountContainer.html#methodfixLDAPAttributes">fixLDAPAttributes</a></li> <li><a href="../modules/accountContainer.html#methodgetAccountModule">getAccountModule</a></li> <li><a href="../modules/accountContainer.html#methodgetAccountModules">getAccountModules</a></li> <li><a href="../modules/accountContainer.html#methodgetParentDN">getParentDN</a></li> <li><a href="../modules/accountContainer.html#methodgetRDN">getRDN</a></li> <li><a href="../modules/accountContainer.html#methodget_pdfEntries">get_pdfEntries</a></li> <li><a href="../modules/accountContainer.html#methodget_type">get_type</a></li> <li><a href="../modules/accountContainer.html#methodload_account">load_account</a></li> <li><a href="../modules/accountContainer.html#methodnew_account">new_account</a></li> <li><a href="../modules/accountContainer.html#methodsave_account">save_account</a></li> <li><a href="../modules/accountContainer.html#methodsave_module_attributes">save_module_attributes</a></li> <li><a href="../modules/accountContainer.html#methodsortModules">sortModules</a></li> <li><a href="../modules/accountContainer.html#method__sleep">__sleep</a></li> <li><a href="../modules/accountContainer.html#method__wakeup">__wakeup</a></li> </ul> </td> </tr></table> <hr /> <table width="100%" border="0"><tr> </tr></table> <hr /> <a name="class_details"></a> <h3>Class Details</h3> <div class="tags"> [line 868]<br /> This class includes all modules and attributes of an account.<br /><br /></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 897]</p> Array of all used attributes<br /><br /><p>Syntax is attribute => array ( objectClass => MUST or MAY, ...)</p><br /> <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$attributes_orig"></a> <p></p> <h4>$attributes_orig = <span class="value"></span></h4> <p>[line 918]</p> original LDAP attributes when account was loaded from LDAP<br /><br /> <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$dn"></a> <p></p> <h4>$dn = <span class="value"></span></h4> <p>[line 909]</p> DN suffix of the account<br /><br /> <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$dn_orig"></a> <p></p> <h4>$dn_orig = <span class="value"></span></h4> <p>[line 912]</p> DN suffix of account when it was loaded<br /><br /> <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$isNewAccount"></a> <p></p> <h4>$isNewAccount = <span class="value"></span></h4> <p>[line 933]</p> True if this is a newly created account<br /><br /> <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$rdn"></a> <p></p> <h4>$rdn = <span class="value"></span></h4> <p>[line 915]</p> RDN attribute of this account<br /><br /> <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 876]</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>accountContainer __construct( string $type, string $base)</code> </td></tr></table> </td></tr></table><br /> Constructor<br /><br /><br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">string </td> <td><b>$type</b> </td> <td>account type</td> </tr> <tr> <td class="type">string </td> <td><b>$base</b> </td> <td>key in $_SESSION where this object is saved</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodcontinue_main"></a> <h3>method continue_main <span class="smalllinenumber">[line 974]</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 continue_main( )</code> </td></tr></table> </td></tr></table><br /> This function is called when the user clicks on any button on the account pages.<br /><br /><p>It prints the HTML code of each account page.</p><br /><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodfixLDAPAttributes"></a> <h3>method fixLDAPAttributes <span class="smalllinenumber">[line 1489]</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 fixLDAPAttributes( array $attributes, array $modules)</code> </td></tr></table> </td></tr></table><br /> Fixes spelling errors in the attribute names.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>fixed attributes</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>$attributes</b> </td> <td>LDAP attributes</td> </tr> <tr> <td class="type">array </td> <td><b>$modules</b> </td> <td>list of active modules</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodgetAccountModule"></a> <h3>method getAccountModule <span class="smalllinenumber">[line 943]</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/baseModule.html">baseModule</a> getAccountModule( string $name)</code> </td></tr></table> </td></tr></table><br /> Returns the account module with the given class name<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 module</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>$name</b> </td> <td>class name (e.g. posixAccount)</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodgetAccountModules"></a> <h3>method getAccountModules <span class="smalllinenumber">[line 957]</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 getAccountModules( )</code> </td></tr></table> </td></tr></table><br /> Returns the included account modules.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>modules</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodgetParentDN"></a> <h3>method getParentDN <span class="smalllinenumber">[line 1826]</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 getParentDN( String $dn)</code> </td></tr></table> </td></tr></table><br /> Returns the parent DN of a given DN.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>DN</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>$dn</b> </td> <td>DN</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodgetRDN"></a> <h3>method getRDN <span class="smalllinenumber">[line 1814]</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 getRDN( String $dn)</code> </td></tr></table> </td></tr></table><br /> Returns the RDN part of a given DN.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>RDN</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>$dn</b> </td> <td>DN</td> </tr> </table> </div><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 1738]</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 get_pdfEntries( )</code> </td></tr></table> </td></tr></table><br /> Returns a list of possible PDF entries for this 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>of PDF entries (array(<name> => <PDF lines>))</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodget_type"></a> <h3>method get_type <span class="smalllinenumber">[line 966]</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_type( )</code> </td></tr></table> </td></tr></table><br /> Returns the accout type of this object (e.g. 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> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodload_account"></a> <h3>method load_account <span class="smalllinenumber">[line 1430]</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 load_account( string $dn)</code> </td></tr></table> </td></tr></table><br /> Loads an LDAP account with the given DN.<br /><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> </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>$dn</b> </td> <td>the DN of the account</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodnew_account"></a> <h3>method new_account <span class="smalllinenumber">[line 1562]</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 new_account( )</code> </td></tr></table> </td></tr></table><br /> This function will prepare the object for a new account.<br /><br /><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodsave_account"></a> <h3>method save_account <span class="smalllinenumber">[line 1592]</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_account( )</code> </td></tr></table> </td></tr></table><br /> This function will save an account to the LDAP database.<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 status messages if any errors occured</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodsave_module_attributes"></a> <h3>method save_module_attributes <span class="smalllinenumber">[line 1352]</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_module_attributes( array $attributes, array $orig)</code> </td></tr></table> </td></tr></table><br /> This function checks which LDAP attributes have changed while the account was edited.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>an array which can be passed to $this->saveAccount()</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>$attributes</b> </td> <td>list of current LDAP attributes</td> </tr> <tr> <td class="type">array </td> <td><b>$orig</b> </td> <td>list of old attributes when account was loaded</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodsortModules"></a> <h3>method sortModules <span class="smalllinenumber">[line 1751]</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 sortModules( )</code> </td></tr></table> </td></tr></table><br /> Sorts the module buttons for the account page.<br /><br /><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="method__sleep"></a> <h3>method __sleep <span class="smalllinenumber">[line 1837]</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 __sleep( )</code> </td></tr></table> </td></tr></table><br /> Encrypts sensitive data before storing in session.<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 attributes which are serialized</td> </tr> </table> </div> <br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="method__wakeup"></a> <h3>method __wakeup <span class="smalllinenumber">[line 1849]</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 __wakeup( )</code> </td></tr></table> </td></tr></table><br /> Decrypts sensitive data after accountContainer was loaded from session.<br /><br /><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> </div><br /> <div class="credit"> <hr /> Documentation generated on Thu, 07 Feb 2008 20:26:42 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a> </div> </td></tr></table> </td> </tr> </table> </body> </html>