<html> <head> <title>Docs For Class lamList</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: lamList</h1> Source Location: /lib/lists.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">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_vars">Variables</a></h3> <ul> <li><a href="../lists/lamList.html#var$attrArray">$attrArray</a></li> <li><a href="../lists/lamList.html#var$descArray">$descArray</a></li> <li><a href="../lists/lamList.html#var$entries">$entries</a></li> <li><a href="../lists/lamList.html#var$filterText">$filterText</a></li> <li><a href="../lists/lamList.html#var$labels">$labels</a></li> <li><a href="../lists/lamList.html#var$maxPageEntries">$maxPageEntries</a></li> <li><a href="../lists/lamList.html#var$page">$page</a></li> <li><a href="../lists/lamList.html#var$possibleSuffixes">$possibleSuffixes</a></li> <li><a href="../lists/lamList.html#var$refresh">$refresh</a></li> <li><a href="../lists/lamList.html#var$sortColumn">$sortColumn</a></li> <li><a href="../lists/lamList.html#var$sortDirection">$sortDirection</a></li> <li><a href="../lists/lamList.html#var$suffix">$suffix</a></li> <li><a href="../lists/lamList.html#var$type">$type</a></li> </ul> </td> <td valign="top"> <h3><a href="#class_consts">Constants</a></h3> <ul> <li><a href="../lists/lamList.html#constLIST_SIZE_OPTION_NAME">LIST_SIZE_OPTION_NAME</a></li> </ul> </td> <td valign="top"> <h3><a href="#class_methods">Methods</a></h3> <ul> <li><a href="../lists/lamList.html#method__construct">__construct</a></li> <li><a href="../lists/lamList.html#methodcmp_array">cmp_array</a></li> <li><a href="../lists/lamList.html#methodgetAdditionalTools">getAdditionalTools</a></li> <li><a href="../lists/lamList.html#methodlistBuildFilter">listBuildFilter</a></li> <li><a href="../lists/lamList.html#methodlistConfigurationChanged">listConfigurationChanged</a></li> <li><a href="../lists/lamList.html#methodlistDoPost">listDoPost</a></li> <li><a href="../lists/lamList.html#methodlistDrawNavigationBar">listDrawNavigationBar</a></li> <li><a href="../lists/lamList.html#methodlistFilterAccounts">listFilterAccounts</a></li> <li><a href="../lists/lamList.html#methodlistGetAllConfigOptions">listGetAllConfigOptions</a></li> <li><a href="../lists/lamList.html#methodlistGetConfigOptionByID">listGetConfigOptionByID</a></li> <li><a href="../lists/lamList.html#methodlistGetParams">listGetParams</a></li> <li><a href="../lists/lamList.html#methodlistPrintButtons">listPrintButtons</a></li> <li><a href="../lists/lamList.html#methodlistPrintConfigurationPage">listPrintConfigurationPage</a></li> <li><a href="../lists/lamList.html#methodlistPrintFooter">listPrintFooter</a></li> <li><a href="../lists/lamList.html#methodlistPrintHeader">listPrintHeader</a></li> <li><a href="../lists/lamList.html#methodlistPrintTableBody">listPrintTableBody</a></li> <li><a href="../lists/lamList.html#methodlistPrintTableCellContent">listPrintTableCellContent</a></li> <li><a href="../lists/lamList.html#methodlistPrintTableHeader">listPrintTableHeader</a></li> <li><a href="../lists/lamList.html#methodlistRefreshData">listRefreshData</a></li> <li><a href="../lists/lamList.html#methodlistShowOUSelection">listShowOUSelection</a></li> <li><a href="../lists/lamList.html#methodlistSort">listSort</a></li> <li><a href="../lists/lamList.html#methodshowPage">showPage</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="../lists/lamGroupList.html">lamGroupList</a></dt> <dd>Generates the list view.</dd> </dl> <dl> <dt><a href="../lists/lamHostList.html">lamHostList</a></dt> <dd>Generates the list view.</dd> </dl> <dl> <dt><a href="../lists/lamMailAliasList.html">lamMailAliasList</a></dt> <dd>Generates the list view.</dd> </dl> <dl> <dt><a href="../lists/lamSmbDomainList.html">lamSmbDomainList</a></dt> <dd>Generates the list view.</dd> </dl> <dl> <dt><a href="../lists/lamUserList.html">lamUserList</a></dt> <dd>Generates the list view.</dd> </dl> </div> </td> </tr></table> <hr /> <a name="class_details"></a> <h3>Class Details</h3> <div class="tags"> [line 47]<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_vars"></a> <h3>Class Variables</h3> <div class="tags"> <a name="var$attrArray"></a> <p></p> <h4>$attrArray = <span class="value">array()</span></h4> <p>[line 56]</p> list of LDAP attributes<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$descArray"></a> <p></p> <h4>$descArray = <span class="value">array()</span></h4> <p>[line 59]</p> list of attribute descriptions<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$entries"></a> <p></p> <h4>$entries = <span class="value"></span></h4> <p>[line 77]</p> LDAP entries<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$filterText"></a> <p></p> <h4>$filterText = <span class="value"></span></h4> <p>[line 80]</p> filter string to include in URL<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$labels"></a> <p></p> <h4>$labels = <span class="value"></span></h4> <p>[line 86]</p> list of account specific labels<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$maxPageEntries"></a> <p></p> <h4>$maxPageEntries = <span class="value"> 30</span></h4> <p>[line 62]</p> maximum count of entries per page<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$page"></a> <p></p> <h4>$page = <span class="value"> 1</span></h4> <p>[line 53]</p> current page number<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$possibleSuffixes"></a> <p></p> <h4>$possibleSuffixes = <span class="value"></span></h4> <p>[line 83]</p> list of possible LDAP suffixes(organizational units)<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$refresh"></a> <p></p> <h4>$refresh = <span class="value"> true</span></h4> <p>[line 74]</p> refresh page switch<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$sortColumn"></a> <p></p> <h4>$sortColumn = <span class="value"></span></h4> <p>[line 65]</p> sort column name<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$sortDirection"></a> <p></p> <h4>$sortDirection = <span class="value"> 1</span></h4> <p>[line 68]</p> sort direction: 1 for ascending, -1 for descending<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$suffix"></a> <p></p> <h4>$suffix = <span class="value"></span></h4> <p>[line 71]</p> LDAP suffix<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$type"></a> <p></p> <h4>$type = <span class="value"></span></h4> <p>[line 50]</p> Account type<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 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><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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../lists/lamGroupList.html#method__construct">lamGroupList::__construct()</a></dt> <dd>Constructor</dd> </dl> <dl> <dt><a href="../lists/lamHostList.html#method__construct">lamHostList::__construct()</a></dt> <dd>Constructor</dd> </dl> <dl> <dt><a href="../lists/lamMailAliasList.html#method__construct">lamMailAliasList::__construct()</a></dt> <dd>Constructor</dd> </dl> <dl> <dt><a href="../lists/lamSmbDomainList.html#method__construct">lamSmbDomainList::__construct()</a></dt> <dd>Constructor</dd> </dl> <dl> <dt><a href="../lists/lamUserList.html#method__construct">lamUserList::__construct()</a></dt> <dd>Constructor</dd> </dl> </p> <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="methodcmp_array"></a> <h3>method cmp_array <span class="smalllinenumber">[line 302]</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>integer cmp_array( &$a, &$b, array $a, array $b)</code> </td></tr></table> </td></tr></table><br /> Compare function used for usort-method<br /><br /><p>Rows are sorted with the first attribute entry of the sort column. If objects have attributes with multiple values only the first is used for sorting.</p><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>0 if both are equal, 1 if $a is greater, -1 if $b is greater</td> </tr> <tr> <td><b>access:</b> </td><td>protected</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>$a</b> </td> <td>first row which is compared</td> </tr> <tr> <td class="type">array </td> <td><b>$b</b> </td> <td>second row which is compared</td> </tr> <tr> <td class="type"> </td> <td><b>&$a</b> </td> <td></td> </tr> <tr> <td class="type"> </td> <td><b>&$b</b> </td> <td></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 865]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../lists/lamUserList.html#methodgetAdditionalTools">lamUserList::getAdditionalTools()</a></dt> <dd>Returns a list of lamListTool objects to display next to the edit/delete buttons.</dd> </dl> </p> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistBuildFilter"></a> <h3>method listBuildFilter <span class="smalllinenumber">[line 204]</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 listBuildFilter( )</code> </td></tr></table> </td></tr></table><br /> Builds the regular expressions from the filter 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>filter data array($attribute => array('regex' => $reg, 'original' => $orig)) $reg is the regular expression to use, $orig the user's unmodified input string</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="methodlistConfigurationChanged"></a> <h3>method listConfigurationChanged <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>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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../lists/lamGroupList.html#methodlistConfigurationChanged">lamGroupList::listConfigurationChanged()</a></dt> <dd>Called when the configuration options changed.</dd> </dl> <dl> <dt><a href="../lists/lamUserList.html#methodlistConfigurationChanged">lamUserList::listConfigurationChanged()</a></dt> <dd>Called when the configuration options changed.</dd> </dl> </p> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistDoPost"></a> <h3>method listDoPost <span class="smalllinenumber">[line 506]</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 listDoPost( )</code> </td></tr></table> </td></tr></table><br /> Manages all POST actions (e.g. button pressed) for the account lists.<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> <hr /> <a name="methodlistDrawNavigationBar"></a> <h3>method listDrawNavigationBar <span class="smalllinenumber">[line 321]</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 listDrawNavigationBar( integer $count)</code> </td></tr></table> </td></tr></table><br /> Draws a navigation bar to switch between pages<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 /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">integer </td> <td><b>$count</b> </td> <td>number of account entries</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistFilterAccounts"></a> <h3>method listFilterAccounts <span class="smalllinenumber">[line 248]</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 listFilterAccounts( )</code> </td></tr></table> </td></tr></table><br /> Removes all entries which do not fit to the filter.<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>filtered list of accounts</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="methodlistGetAllConfigOptions"></a> <h3>method listGetAllConfigOptions <span class="smalllinenumber">[line 874]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../lists/lamGroupList.html#methodlistGetAllConfigOptions">lamGroupList::listGetAllConfigOptions()</a></dt> <dd>Returns a list of possible configuration options.</dd> </dl> <dl> <dt><a href="../lists/lamUserList.html#methodlistGetAllConfigOptions">lamUserList::listGetAllConfigOptions()</a></dt> <dd>Returns a list of possible configuration options.</dd> </dl> </p> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistGetConfigOptionByID"></a> <h3>method listGetConfigOptionByID <span class="smalllinenumber">[line 912]</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 listGetConfigOptionByID( String $ID)</code> </td></tr></table> </td></tr></table><br /> Returns the configuration option with the given ID.<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 /> <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>ID</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistGetParams"></a> <h3>method listGetParams <span class="smalllinenumber">[line 791]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../lists/lamGroupList.html#methodlistGetParams">lamGroupList::listGetParams()</a></dt> <dd>Sets some internal parameters.</dd> </dl> <dl> <dt><a href="../lists/lamUserList.html#methodlistGetParams">lamUserList::listGetParams()</a></dt> <dd>Sets some internal parameters.</dd> </dl> </p> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistPrintButtons"></a> <h3>method listPrintButtons <span class="smalllinenumber">[line 707]</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 listPrintButtons( boolean $createOnly)</code> </td></tr></table> </td></tr></table><br /> Prints the create and delete buttons.<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 /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">boolean </td> <td><b>$createOnly</b> </td> <td>true if only the create button should be displayed</td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistPrintConfigurationPage"></a> <h3>method listPrintConfigurationPage <span class="smalllinenumber">[line 882]</span></h3> <div class="function"> <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border"> <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code"> <code>void listPrintConfigurationPage( )</code> </td></tr></table> </td></tr></table><br /> Prints the list configuration page.<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> <hr /> <a name="methodlistPrintFooter"></a> <h3>method listPrintFooter <span class="smalllinenumber">[line 746]</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 listPrintFooter( )</code> </td></tr></table> </td></tr></table><br /> Prints the HTML footer.<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> <hr /> <a name="methodlistPrintHeader"></a> <h3>method listPrintHeader <span class="smalllinenumber">[line 734]</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 listPrintHeader( )</code> </td></tr></table> </td></tr></table><br /> Prints the HTML header.<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> <hr /> <a name="methodlistPrintTableBody"></a> <h3>method listPrintTableBody <span class="smalllinenumber">[line 412]</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 listPrintTableBody( &$info, array $info)</code> </td></tr></table> </td></tr></table><br /> Prints the entry list<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 /> <h4>Parameters:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td class="type">array </td> <td><b>$info</b> </td> <td>entries</td> </tr> <tr> <td class="type"> </td> <td><b>&$info</b> </td> <td></td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistPrintTableCellContent"></a> <h3>method listPrintTableCellContent <span class="smalllinenumber">[line 487]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../lists/lamGroupList.html#methodlistPrintTableCellContent">lamGroupList::listPrintTableCellContent()</a></dt> <dd>Prints the content of a cell in the account list for a given LDAP entry and attribute.</dd> </dl> <dl> <dt><a href="../lists/lamUserList.html#methodlistPrintTableCellContent">lamUserList::listPrintTableCellContent()</a></dt> <dd>Prints the content of a cell in the account list for a given LDAP entry and attribute.</dd> </dl> </p> <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="methodlistPrintTableHeader"></a> <h3>method listPrintTableHeader <span class="smalllinenumber">[line 360]</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 listPrintTableHeader( )</code> </td></tr></table> </td></tr></table><br /> Prints the attribute and filter row at the account table head<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> <hr /> <a name="methodlistRefreshData"></a> <h3>method listRefreshData <span class="smalllinenumber">[line 830]</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 /> <p>Overridden in child classes as:<br /> <dl> <dt><a href="../lists/lamGroupList.html#methodlistRefreshData">lamGroupList::listRefreshData()</a></dt> <dd>Rereads the entries from LDAP.</dd> </dl> <dl> <dt><a href="../lists/lamUserList.html#methodlistRefreshData">lamUserList::listRefreshData()</a></dt> <dd>Rereads the entries from LDAP.</dd> </dl> </p> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodlistShowOUSelection"></a> <h3>method listShowOUSelection <span class="smalllinenumber">[line 687]</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 listShowOUSelection( )</code> </td></tr></table> </td></tr></table><br /> Prints a combobox with possible sub-DNs.<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> <hr /> <a name="methodlistSort"></a> <h3>method listSort <span class="smalllinenumber">[line 283]</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 listSort( &$info, array $info)</code> </td></tr></table> </td></tr></table><br /> Sorts an account list by a given attribute<br /><br /><br /><br /> <h4>Tags:</h4> <div class="tags"> <table border="0" cellspacing="0" cellpadding="0"> <tr> <td><b>return:</b> </td><td>sorted account list</td> </tr> <tr> <td><b>access:</b> </td><td>protected</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>$info</b> </td> <td>the account list</td> </tr> <tr> <td class="type"> </td> <td><b>&$info</b> </td> <td></td> </tr> </table> </div><br /> <div class="top">[ <a href="#top">Top</a> ]</div> </div> <hr /> <a name="methodshowPage"></a> <h3>method showPage <span class="smalllinenumber">[line 142]</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 showPage( )</code> </td></tr></table> </td></tr></table><br /> Prints the HTML code to display the list view.<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 /> <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="constLIST_SIZE_OPTION_NAME"></a> <p></p> <h4>LIST_SIZE_OPTION_NAME = <span class="value"> "L_SIZE"</span></h4> <p>[line 92]</p> ID for list size 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:26:39 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a> </div> </td></tr></table> </td> </tr> </table> </body> </html>