LDAPAccountManager/lam-web/developers/phpdoc/lists/lamList.html

1036 lines
34 KiB
HTML
Raw Normal View History

2006-11-15 17:12:15 +00:00
<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">
2007-11-04 11:19:11 +00:00
[ <a href="../classtrees_lists.html" class="menu">class tree: lists</a> ]
2006-11-15 17:12:15 +00:00
[ <a href="../elementindex_lists.html" class="menu">index: lists</a> ]
2007-11-04 11:19:11 +00:00
[ <a href="../elementindex.html" class="menu">all elements</a> ]
2006-11-15 17:12:15 +00:00
</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>
2007-11-04 11:19:11 +00:00
<p><a href="../ric_README.html">README</a></p>
2006-11-15 17:12:15 +00:00
</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">
2007-11-04 11:19:11 +00:00
<a href="../lists/_templates---lists---deletelink.php.html"> deletelink.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/_templates---lists---list.php.html"> list.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/_lib---lists.inc.html"> lists.inc
</a><br>
<a href="../lists/_templates---lists---userlink.php.html"> userlink.php
2006-11-15 17:12:15 +00:00
</a><br>
</div><br />
subpackage <b>tree</b><br> <div class="package">
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---add_attr.php.html"> add_attr.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---add_attr_form.php.html"> add_attr_form.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---add_oclass.php.html"> add_oclass.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---add_oclass_form.php.html"> add_oclass_form.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---add_value.php.html"> add_value.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---add_value_form.php.html"> add_value_form.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---collapse.php.html"> collapse.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---create.php.html"> create.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---create_form.php.html"> create_form.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---creation_template.php.html"> creation_template.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---templates---creation---custom.php.html"> custom.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---delete.php.html"> delete.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---delete_attr.php.html"> delete_attr.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---delete_form.php.html"> delete_form.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---download_binary_attr.php.html"> download_binary_attr.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---edit.php.html"> edit.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---expand.php.html"> expand.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---export.php.html"> export.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---export_form.php.html"> export_form.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---templates---creation---new_ou_template.php.html"> new_ou_template.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---rdelete.php.html"> rdelete.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---refresh.php.html"> refresh.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---templates---templates.inc.html"> templates.inc
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_lib---tree.inc.html"> tree.inc
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---tree.php.html"> tree.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---tree_view.php.html"> tree_view.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---update.php.html"> update.php
2006-11-15 17:12:15 +00:00
</a><br>
2007-11-04 11:19:11 +00:00
<a href="../lists/tree/_templates---tree---update_confirm.php.html"> update_confirm.php
2006-11-15 17:12:15 +00:00
</a><br>
</div><br />
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
<b>Classes:</b><br />
<div class="package">
<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/lamMailAliasList.html">lamMailAliasList</a><br />
<a href="../lists/lamSmbDomainList.html">lamSmbDomainList</a><br />
<a href="../lists/lamUserList.html">lamUserList</a><br />
</div>
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
</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$suffix">$suffix</a></li>
<li><a href="../lists/lamList.html#var$type">$type</a></li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../lists/lamList.html#methodlamList">lamList</a></li>
<li><a href="../lists/lamList.html#methodcmp_array">cmp_array</a></li>
<li><a href="../lists/lamList.html#methodlistBuildFilter">listBuildFilter</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#methodlistGetAttributeDescriptionList">listGetAttributeDescriptionList</a></li>
<li><a href="../lists/lamList.html#methodlistGetParams">listGetParams</a></li>
2007-11-04 11:19:11 +00:00
<li><a href="../lists/lamList.html#methodlistPrintAdditionalOptions">listPrintAdditionalOptions</a></li>
2006-11-15 17:12:15 +00:00
<li><a href="../lists/lamList.html#methodlistPrintButtons">listPrintButtons</a></li>
<li><a href="../lists/lamList.html#methodlistPrintHeader">listPrintHeader</a></li>
<li><a href="../lists/lamList.html#methodlistPrintJavaScript">listPrintJavaScript</a></li>
2007-11-04 11:19:11 +00:00
<li><a href="../lists/lamList.html#methodlistPrintPDFButtons">listPrintPDFButtons</a></li>
2006-11-15 17:12:15 +00:00
<li><a href="../lists/lamList.html#methodlistPrintTableBody">listPrintTableBody</a></li>
2007-11-04 11:19:11 +00:00
<li><a href="../lists/lamList.html#methodlistPrintTableCellContent">listPrintTableCellContent</a></li>
2006-11-15 17:12:15 +00:00
<li><a href="../lists/lamList.html#methodlistPrintTableHeader">listPrintTableHeader</a></li>
2007-11-04 11:19:11 +00:00
<li><a href="../lists/lamList.html#methodlistPrintToolLinks">listPrintToolLinks</a></li>
2006-11-15 17:12:15 +00:00
<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>
2007-11-04 11:19:11 +00:00
<dt><a href="../lists/lamGroupList.html">lamGroupList</a></dt>
2006-11-15 17:12:15 +00:00
<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>
2007-11-04 11:19:11 +00:00
<dt><a href="../lists/lamMailAliasList.html">lamMailAliasList</a></dt>
2006-11-15 17:12:15 +00:00
<dd>Generates the list view.</dd>
</dl>
<dl>
2007-11-04 11:19:11 +00:00
<dt><a href="../lists/lamSmbDomainList.html">lamSmbDomainList</a></dt>
2006-11-15 17:12:15 +00:00
<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>&nbsp;&nbsp;</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 />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 74]</p>
LDAP entries<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 77]</p>
filter string to include in URL<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 83]</p>
list of account specific labels<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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">&nbsp;10</span></h4>
<p>[line 62]</p>
maximum count of entries per page<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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">&nbsp;1</span></h4>
<p>[line 53]</p>
current page number<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 80]</p>
list of possible LDAP suffixes(organizational units)<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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">&nbsp;true</span></h4>
<p>[line 71]</p>
refresh page switch<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 68]</p>
LDAP suffix<br /><br />
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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 />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</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="methodlamList"></a>
<h3>constructor lamList <span class="smalllinenumber">[line 91]</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> lamList(
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>&nbsp;&nbsp;</td><td>list object</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$type</b>&nbsp;&nbsp;</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>
2007-11-04 11:19:11 +00:00
<h3>method cmp_array <span class="smalllinenumber">[line 265]</span></h3>
2006-11-15 17:12:15 +00:00
<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(
2007-11-04 11:19:11 +00:00
&$a,
&$b, array
2006-11-15 17:12:15 +00:00
$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>&nbsp;&nbsp;</td><td>0 if both are equal, 1 if $a is greater, -1 if $b is greater</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$a</b>&nbsp;&nbsp;</td>
<td>first row which is compared</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$b</b>&nbsp;&nbsp;</td>
<td>second row which is compared</td>
2007-11-04 11:19:11 +00:00
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>&$a</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>&$b</b>&nbsp;&nbsp;</td>
<td></td>
2006-11-15 17:12:15 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistBuildFilter"></a>
2007-11-04 11:19:11 +00:00
<h3>method listBuildFilter <span class="smalllinenumber">[line 167]</span></h3>
2006-11-15 17:12:15 +00:00
<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>&nbsp;&nbsp;</td><td>filter data array($attribute =&gt; array('regex' =&gt; $reg, 'original' =&gt; $orig)) $reg is the regular expression to use, $orig the user's unmodified input string</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistDoPost"></a>
2007-11-04 11:19:11 +00:00
<h3>method listDoPost <span class="smalllinenumber">[line 449]</span></h3>
2006-11-15 17:12:15 +00:00
<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 />
<p>Overridden in child classes as:<br />
<dl>
2007-11-04 11:19:11 +00:00
<dt><a href="../lists/lamGroupList.html#methodlistDoPost">lamGroupList::listDoPost()</a></dt>
<dd>Manages all POST actions (e.g. button pressed) for the account lists.</dd>
</dl>
<dl>
2006-11-15 17:12:15 +00:00
<dt><a href="../lists/lamUserList.html#methodlistDoPost">lamUserList::listDoPost()</a></dt>
<dd>Manages all POST actions (e.g. button pressed) for the account lists.</dd>
</dl>
</p>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistDrawNavigationBar"></a>
2007-11-04 11:19:11 +00:00
<h3>method listDrawNavigationBar <span class="smalllinenumber">[line 284]</span></h3>
2006-11-15 17:12:15 +00:00
<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>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">integer&nbsp;&nbsp;</td>
<td><b>$count</b>&nbsp;&nbsp;</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>
2007-11-04 11:19:11 +00:00
<h3>method listFilterAccounts <span class="smalllinenumber">[line 211]</span></h3>
2006-11-15 17:12:15 +00:00
<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>&nbsp;&nbsp;</td><td>filtered list of accounts</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistGetAttributeDescriptionList"></a>
2007-11-04 11:19:11 +00:00
<h3>method listGetAttributeDescriptionList <span class="smalllinenumber">[line 633]</span></h3>
2006-11-15 17:12:15 +00:00
<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 listGetAttributeDescriptionList(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns an hash array containing with all attributes to be shown and their descriptions.<br /><br /><p>Format: array(attribute =&gt; description)</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>attribute list</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistGetParams"></a>
2007-11-04 11:19:11 +00:00
<h3>method listGetParams <span class="smalllinenumber">[line 667]</span></h3>
2006-11-15 17:12:15 +00:00
<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 />
2007-11-04 11:19:11 +00:00
<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>
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistPrintAdditionalOptions"></a>
<h3>method listPrintAdditionalOptions <span class="smalllinenumber">[line 729]</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 listPrintAdditionalOptions(
)</code>
</td></tr></table>
</td></tr></table><br />
Prints additional option fields for specific object types.<br /><br /><br /><br />
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../lists/lamGroupList.html#methodlistPrintAdditionalOptions">lamGroupList::listPrintAdditionalOptions()</a></dt>
<dd>Prints additional option field for primary member display.</dd>
</dl>
<dl>
<dt><a href="../lists/lamUserList.html#methodlistPrintAdditionalOptions">lamUserList::listPrintAdditionalOptions()</a></dt>
<dd>Prints additional option fields for specific object types.</dd>
</dl>
</p>
2006-11-15 17:12:15 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistPrintButtons"></a>
2007-11-04 11:19:11 +00:00
<h3>method listPrintButtons <span class="smalllinenumber">[line 539]</span></h3>
2006-11-15 17:12:15 +00:00
<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, delete and PDF buttons.<br /><br /><br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$createOnly</b>&nbsp;&nbsp;</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="methodlistPrintHeader"></a>
2007-11-04 11:19:11 +00:00
<h3>method listPrintHeader <span class="smalllinenumber">[line 576]</span></h3>
2006-11-15 17:12:15 +00:00
<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 head.<br /><br /><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistPrintJavaScript"></a>
2007-11-04 11:19:11 +00:00
<h3>method listPrintJavaScript <span class="smalllinenumber">[line 588]</span></h3>
2006-11-15 17:12:15 +00:00
<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 listPrintJavaScript(
)</code>
</td></tr></table>
</td></tr></table><br />
Prints JavaScript code needed for mouse-over effects.<br /><br /><br /><br />
2007-11-04 11:19:11 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistPrintPDFButtons"></a>
<h3>method listPrintPDFButtons <span class="smalllinenumber">[line 559]</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 listPrintPDFButtons(
)</code>
</td></tr></table>
</td></tr></table><br />
Prints the PDF button bar.<br /><br /><br /><br />
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistPrintTableBody"></a>
2007-11-04 11:19:11 +00:00
<h3>method listPrintTableBody <span class="smalllinenumber">[line 367]</span></h3>
2006-11-15 17:12:15 +00:00
<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(
2007-11-04 11:19:11 +00:00
&$info, array
2006-11-15 17:12:15 +00:00
$info)</code>
</td></tr></table>
</td></tr></table><br />
Prints the entry list<br /><br /><br /><br />
2007-11-04 11:19:11 +00:00
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$info</b>&nbsp;&nbsp;</td>
<td>entries</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>&$info</b>&nbsp;&nbsp;</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 430]</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 />
2006-11-15 17:12:15 +00:00
<p>Overridden in child classes as:<br />
<dl>
2007-11-04 11:19:11 +00:00
<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>
2006-11-15 17:12:15 +00:00
</dl>
<dl>
2007-11-04 11:19:11 +00:00
<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>
2006-11-15 17:12:15 +00:00
</dl>
</p>
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
2007-11-04 11:19:11 +00:00
<td><b>$entry</b>&nbsp;&nbsp;</td>
<td>LDAP attributes</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$attribute</b>&nbsp;&nbsp;</td>
<td>attribute name</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>&$entry</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>&$attribute</b>&nbsp;&nbsp;</td>
<td></td>
2006-11-15 17:12:15 +00:00
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistPrintTableHeader"></a>
2007-11-04 11:19:11 +00:00
<h3>method listPrintTableHeader <span class="smalllinenumber">[line 320]</span></h3>
2006-11-15 17:12:15 +00:00
<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 />
2007-11-04 11:19:11 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistPrintToolLinks"></a>
<h3>method listPrintToolLinks <span class="smalllinenumber">[line 413]</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 listPrintToolLinks(
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
$account)</code>
</td></tr></table>
</td></tr></table><br />
Prints the tool image links (e.g. edit and delete) for each account.<br /><br /><p>$account array LDAP attributes</p><br /><br /><br />
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$account</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
2006-11-15 17:12:15 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistRefreshData"></a>
2007-11-04 11:19:11 +00:00
<h3>method listRefreshData <span class="smalllinenumber">[line 696]</span></h3>
2006-11-15 17:12:15 +00:00
<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 />
2007-11-04 11:19:11 +00:00
<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>
2006-11-15 17:12:15 +00:00
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistShowOUSelection"></a>
2007-11-04 11:19:11 +00:00
<h3>method listShowOUSelection <span class="smalllinenumber">[line 519]</span></h3>
2006-11-15 17:12:15 +00:00
<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 />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodlistSort"></a>
2007-11-04 11:19:11 +00:00
<h3>method listSort <span class="smalllinenumber">[line 246]</span></h3>
2006-11-15 17:12:15 +00:00
<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(
2007-11-04 11:19:11 +00:00
&$info, array
2006-11-15 17:12:15 +00:00
$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>&nbsp;&nbsp;</td><td>sorted account list</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$info</b>&nbsp;&nbsp;</td>
<td>the account list</td>
2007-11-04 11:19:11 +00:00
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>&$info</b>&nbsp;&nbsp;</td>
<td></td>
2006-11-15 17:12:15 +00:00
</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 105]</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 />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
<div class="credit">
<hr />
2007-11-04 11:19:11 +00:00
Documentation generated on Sun, 04 Nov 2007 12:10:55 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
2006-11-15 17:12:15 +00:00
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>