<html> <head> <title>Docs For Class lamUserList</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">lists</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_lists.html" class="menu">class tree: lists</a> ] [ <a href="../elementindex_lists.html" class="menu">index: lists</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="../lists/_templates---lists---deletelink.php.html"> deletelink.php </a><br> <a href="../lists/_templates---lists---list.php.html"> list.php </a><br> <a href="../lists/_lib---lists.inc.html"> lists.inc </a><br> <a href="../lists/_templates---lists---userlink.php.html"> userlink.php </a><br> </div><br /> subpackage <b>tree</b><br> <div class="package"> <a href="../lists/tree/_templates---tree---add_attr.php.html"> add_attr.php </a><br> <a href="../lists/tree/_templates---tree---add_attr_form.php.html"> add_attr_form.php </a><br> <a href="../lists/tree/_templates---tree---add_oclass.php.html"> add_oclass.php </a><br> <a href="../lists/tree/_templates---tree---add_oclass_form.php.html"> add_oclass_form.php </a><br> <a href="../lists/tree/_templates---tree---add_value.php.html"> add_value.php </a><br> <a href="../lists/tree/_templates---tree---add_value_form.php.html"> add_value_form.php </a><br> <a href="../lists/tree/_templates---tree---collapse.php.html"> collapse.php </a><br> <a href="../lists/tree/_templates---tree---create.php.html"> create.php </a><br> <a href="../lists/tree/_templates---tree---create_form.php.html"> create_form.php </a><br> <a href="../lists/tree/_templates---tree---creation_template.php.html"> creation_template.php </a><br> <a href="../lists/tree/_templates---tree---templates---creation---custom.php.html"> custom.php </a><br> <a href="../lists/tree/_templates---tree---delete.php.html"> delete.php </a><br> <a href="../lists/tree/_templates---tree---delete_attr.php.html"> delete_attr.php </a><br> <a href="../lists/tree/_templates---tree---delete_form.php.html"> delete_form.php </a><br> <a href="../lists/tree/_templates---tree---download_binary_attr.php.html"> download_binary_attr.php </a><br> <a href="../lists/tree/_templates---tree---edit.php.html"> edit.php </a><br> <a href="../lists/tree/_templates---tree---expand.php.html"> expand.php </a><br> <a href="../lists/tree/_templates---tree---export.php.html"> export.php </a><br> <a href="../lists/tree/_templates---tree---export_form.php.html"> export_form.php </a><br> <a href="../lists/tree/_templates---tree---templates---creation---new_ou_template.php.html"> new_ou_template.php </a><br> <a href="../lists/tree/_templates---tree---rdelete.php.html"> rdelete.php </a><br> <a href="../lists/tree/_templates---tree---refresh.php.html"> refresh.php </a><br> <a href="../lists/tree/_templates---tree---templates---templates.inc.html"> templates.inc </a><br> <a href="../lists/tree/_lib---tree.inc.html"> tree.inc </a><br> <a href="../lists/tree/_templates---tree---tree.php.html"> tree.php </a><br> <a href="../lists/tree/_templates---tree---tree_view.php.html"> tree_view.php </a><br> <a href="../lists/tree/_templates---tree---update.php.html"> update.php </a><br> <a href="../lists/tree/_templates---tree---update_confirm.php.html"> update_confirm.php </a><br> </div><br /> <b>Classes:</b><br /> <div class="package"> <a href="../lists/lamBooleanListOption.html">lamBooleanListOption</a><br /> <a href="../lists/lamGroupList.html">lamGroupList</a><br /> <a href="../lists/lamHostList.html">lamHostList</a><br /> <a href="../lists/lamList.html">lamList</a><br /> <a href="../lists/lamListOption.html">lamListOption</a><br /> <a href="../lists/lamListTool.html">lamListTool</a><br /> <a href="../lists/lamMailAliasList.html">lamMailAliasList</a><br /> <a href="../lists/lamSelectListOption.html">lamSelectListOption</a><br /> <a href="../lists/lamSmbDomainList.html">lamSmbDomainList</a><br /> <a href="../lists/lamUserList.html">lamUserList</a><br /> </div> </td> <td> <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top"> <h1>Class: lamUserList</h1> Source Location: /lib/types/user.inc<br /><br /> <table width="100%" border="0"> <tr><td valign="top"> <h3><a href="#class_details">Class Overview</a></h3> <pre><a href="../lists/lamList.html">lamList</a> | --lamUserList</pre><br /> <div class="description">Generates the list view.</div><br /><br /> <h4>Author(s):</h4> <ul> <li>Roland Gruber</li> </ul> </td> <td valign="top"> <h3><a href="#class_consts">Constants</a></h3> <ul> <li><a href="../lists/lamUserList.html#constTRANS_PRIMARY_OPTION_NAME">TRANS_PRIMARY_OPTION_NAME</a></li> </ul> </td> <td valign="top"> <h3><a href="#class_methods">Methods</a></h3> <ul> <li><a href="../lists/lamUserList.html#method__construct">__construct</a></li> <li><a href="../lists/lamUserList.html#methodgetAdditionalTools">getAdditionalTools</a></li> <li><a href="../lists/lamUserList.html#methodlistConfigurationChanged">listConfigurationChanged</a></li> <li><a href="../lists/lamUserList.html#methodlistGetAllConfigOptions">listGetAllConfigOptions</a></li> <li><a href="../lists/lamUserList.html#methodlistGetParams">listGetParams</a></li> <li><a href="../lists/lamUserList.html#methodlistPrintTableCellContent">listPrintTableCellContent</a></li> <li><a href="../lists/lamUserList.html#methodlistRefreshData">listRefreshData</a></li> <li><a href="../lists/lamUserList.html#methodrefreshPrimaryGroupTranslation">refreshPrimaryGroupTranslation</a></li> </ul> </td> </tr></table> <hr /> <table width="100%" border="0"><tr> <td valign="top"> <h3>Inherited Constants</h3> <div class="tags"> <h4>Class: <a href="../lists/lamList.html">lamList</a></h4> <dl> <dt> <a href="../lists/lamList.html#constLIST_SIZE_OPTION_NAME">lamList::LIST_SIZE_OPTION_NAME</a> </dt> <dd> </dd> </dl> </div> </td> <td valign="top"> <h3>Inherited Variables</h3> <div class="tags"> <h4>Class: <a href="../lists/lamList.html">lamList</a></h4> <dl> <dt> <a href="../lists/lamList.html#var$attrArray">lamList::$attrArray</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$descArray">lamList::$descArray</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$entries">lamList::$entries</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$filterText">lamList::$filterText</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$labels">lamList::$labels</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$maxPageEntries">lamList::$maxPageEntries</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$page">lamList::$page</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$possibleSuffixes">lamList::$possibleSuffixes</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$refresh">lamList::$refresh</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$sortColumn">lamList::$sortColumn</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$sortDirection">lamList::$sortDirection</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$suffix">lamList::$suffix</a> </dt> <dd> </dd> <dt> <a href="../lists/lamList.html#var$type">lamList::$type</a> </dt> <dd> </dd> </dl> </div> </td> <td valign="top"> <h3>Inherited Methods</h3> <div class="tags"> <h4>Class: <a href="../lists/lamList.html">lamList</a></h4> <dl> <dt> <a href="../lists/lamList.html#method__construct">lamList::__construct()</a> </dt> <dd> Constructor </dd> <dt> <a href="../lists/lamList.html#methodcmp_array">lamList::cmp_array()</a> </dt> <dd> Compare function used for usort-method </dd> <dt> <a href="../lists/lamList.html#methodgetAdditionalTools">lamList::getAdditionalTools()</a> </dt> <dd> Returns a list of lamListTool objects to display next to the edit/delete buttons. </dd> <dt> <a href="../lists/lamList.html#methodlistBuildFilter">lamList::listBuildFilter()</a> </dt> <dd> Builds the regular expressions from the filter values. </dd> <dt> <a href="../lists/lamList.html#methodlistConfigurationChanged">lamList::listConfigurationChanged()</a> </dt> <dd> Called when the configuration options changed. </dd> <dt> <a href="../lists/lamList.html#methodlistDoPost">lamList::listDoPost()</a> </dt> <dd> Manages all POST actions (e.g. button pressed) for the account lists. </dd> <dt> <a href="../lists/lamList.html#methodlistDrawNavigationBar">lamList::listDrawNavigationBar()</a> </dt> <dd> Draws a navigation bar to switch between pages </dd> <dt> <a href="../lists/lamList.html#methodlistFilterAccounts">lamList::listFilterAccounts()</a> </dt> <dd> Removes all entries which do not fit to the filter. </dd> <dt> <a href="../lists/lamList.html#methodlistGetAllConfigOptions">lamList::listGetAllConfigOptions()</a> </dt> <dd> Returns a list of possible configuration options. </dd> <dt> <a href="../lists/lamList.html#methodlistGetConfigOptionByID">lamList::listGetConfigOptionByID()</a> </dt> <dd> Returns the configuration option with the given ID. </dd> <dt> <a href="../lists/lamList.html#methodlistGetParams">lamList::listGetParams()</a> </dt> <dd> Sets some internal parameters. </dd> <dt> <a href="../lists/lamList.html#methodlistPrintButtons">lamList::listPrintButtons()</a> </dt> <dd> Prints the create and delete buttons. </dd> <dt> <a href="../lists/lamList.html#methodlistPrintConfigurationPage">lamList::listPrintConfigurationPage()</a> </dt> <dd> Prints the list configuration page. </dd> <dt> <a href="../lists/lamList.html#methodlistPrintFooter">lamList::listPrintFooter()</a> </dt> <dd> Prints the HTML footer. </dd> <dt> <a href="../lists/lamList.html#methodlistPrintHeader">lamList::listPrintHeader()</a> </dt> <dd> Prints the HTML header. </dd> <dt> <a href="../lists/lamList.html#methodlistPrintTableBody">lamList::listPrintTableBody()</a> </dt> <dd> Prints the entry list </dd> <dt> <a href="../lists/lamList.html#methodlistPrintTableCellContent">lamList::listPrintTableCellContent()</a> </dt> <dd> Prints the content of a cell in the account list for a given LDAP entry and attribute. </dd> <dt> <a href="../lists/lamList.html#methodlistPrintTableHeader">lamList::listPrintTableHeader()</a> </dt> <dd> Prints the attribute and filter row at the account table head </dd> <dt> <a href="../lists/lamList.html#methodlistRefreshData">lamList::listRefreshData()</a> </dt> <dd> Rereads the entries from LDAP. </dd> <dt> <a href="../lists/lamList.html#methodlistShowOUSelection">lamList::listShowOUSelection()</a> </dt> <dd> Prints a combobox with possible sub-DNs. </dd> <dt> <a href="../lists/lamList.html#methodlistSort">lamList::listSort()</a> </dt> <dd> Sorts an account list by a given attribute </dd> <dt> <a href="../lists/lamList.html#methodshowPage">lamList::showPage()</a> </dt> <dd> Prints the HTML code to display the list view. </dd> </dl> </div> </td> </tr></table> <hr /> <a name="class_details"></a> <h3>Class Details</h3> <div class="tags"> [line 106]<br /> Generates the list view.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>author:</b> </td><td>Roland Gruber</td> </tr> </table> </div> </div><br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /> <hr /> <a name="class_methods"></a> <h3>Class Methods</h3> <div class="tags"> <hr /> <a name="method__construct"></a> <h3>constructor __construct <span class="smalllinenumber">[line 123]</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="../lists/lamList.html">lamList</a> __construct( string $type)</code> </td></tr></table> </td></tr></table><br /> Constructor<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 object</td> </tr> <tr> <td><b>access:</b> </td><td>public</td> </tr> </table> </div> <br /><br /> Overrides <a href="../lists/lamList.html#method__construct">lamList::__construct()</a> (Constructor)<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> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodgetAdditionalTools"></a> <h3>method getAdditionalTools <span class="smalllinenumber">[line 234]</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>lamListTool[] getAdditionalTools( )</code> </td></tr></table> </td></tr></table><br /> Returns a list of lamListTool objects to display next to the edit/delete buttons.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>tools</td> </tr> <tr> <td><b>access:</b> </td><td>protected</td> </tr> </table> </div> <br /><br /> Overrides <a href="../lists/lamList.html#methodgetAdditionalTools">lamList::getAdditionalTools()</a> (Returns a list of lamListTool objects to display next to the edit/delete buttons.)<br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistConfigurationChanged"></a> <h3>method listConfigurationChanged <span class="smalllinenumber">[line 256]</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 listConfigurationChanged( )</code> </td></tr></table> </td></tr></table><br /> Called when the configuration options changed.<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 /><br /> Overrides <a href="../lists/lamList.html#methodlistConfigurationChanged">lamList::listConfigurationChanged()</a> (Called when the configuration options changed.)<br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistGetAllConfigOptions"></a> <h3>method listGetAllConfigOptions <span class="smalllinenumber">[line 247]</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 listGetAllConfigOptions( )</code> </td></tr></table> </td></tr></table><br /> Returns a list of possible configuration options.<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 lamListOption objects</td> </tr> <tr> <td><b>access:</b> </td><td>protected</td> </tr> </table> </div> <br /><br /> Overrides <a href="../lists/lamList.html#methodlistGetAllConfigOptions">lamList::listGetAllConfigOptions()</a> (Returns a list of possible configuration options.)<br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistGetParams"></a> <h3>method listGetParams <span class="smalllinenumber">[line 137]</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 listGetParams( )</code> </td></tr></table> </td></tr></table><br /> Sets some internal parameters.<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 /><br /> Overrides <a href="../lists/lamList.html#methodlistGetParams">lamList::listGetParams()</a> (Sets some internal parameters.)<br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistPrintTableCellContent"></a> <h3>method listPrintTableCellContent <span class="smalllinenumber">[line 179]</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 listPrintTableCellContent( &$entry, &$attribute, array $entry, string $attribute)</code> </td></tr></table> </td></tr></table><br /> Prints the content of a cell in the account list for a given LDAP entry and attribute.<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 /><br /> Overrides <a href="../lists/lamList.html#methodlistPrintTableCellContent">lamList::listPrintTableCellContent()</a> (Prints the content of a cell in the account list for a given LDAP entry and attribute.)<br /><br /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">array </td> <td><b>$entry</b> </td> <td>LDAP attributes</td> </tr> <tr> <td class="type">string </td> <td><b>$attribute</b> </td> <td>attribute name</td> </tr> <tr> <td class="type"> </td> <td><b>&$entry</b> </td> <td></td> </tr> <tr> <td class="type"> </td> <td><b>&$attribute</b> </td> <td></td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistRefreshData"></a> <h3>method listRefreshData <span class="smalllinenumber">[line 148]</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 listRefreshData( )</code> </td></tr></table> </td></tr></table><br /> Rereads the entries 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 /><br /> Overrides <a href="../lists/lamList.html#methodlistRefreshData">lamList::listRefreshData()</a> (Rereads the entries from LDAP.)<br /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodrefreshPrimaryGroupTranslation"></a> <h3>method refreshPrimaryGroupTranslation <span class="smalllinenumber">[line 158]</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 refreshPrimaryGroupTranslation( )</code> </td></tr></table> </td></tr></table><br /> Refreshes the GID to group name cache.<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 /><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> </div><br /> <hr /> <a name="class_constss"></a> <h3>Class Constants</h3> <div class="tags"> <a name="constTRANS_PRIMARY_OPTION_NAME"></a> <p></p> <h4>TRANS_PRIMARY_OPTION_NAME = <span class="value"> "LU_TP"</span></h4> <p>[line 115]</p> ID for config option<br /><br /> <br /> <div class="top">[ <a href="#top">Top</a> ]</div><br /> </div><br /> <div class="credit"> <hr /> Documentation generated on Thu, 07 Feb 2008 20:27:02 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a> </div> </td></tr></table> </td> </tr> </table> </body> </html>