516 lines
35 KiB
HTML
516 lines
35 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<title>Package lists Element Index</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_README.html">README</a></p>
|
||
|
|
<p><a href="ric_INSTALL.html">INSTALL</a></p>
|
||
|
|
</div>
|
||
|
|
<b>Packages:</b><br />
|
||
|
|
<a href="li_PDF.html">PDF</a><br />
|
||
|
|
<a href="li_lists.html">lists</a><br />
|
||
|
|
<a href="li_profiles.html">profiles</a><br />
|
||
|
|
<a href="li_LDAP.html">LDAP</a><br />
|
||
|
|
<a href="li_types.html">types</a><br />
|
||
|
|
<a href="li_lib.html">lib</a><br />
|
||
|
|
<a href="li_modules.html">modules</a><br />
|
||
|
|
<a href="li_selfService.html">selfService</a><br />
|
||
|
|
<a href="li_configuration.html">configuration</a><br />
|
||
|
|
<a href="li_tools.html">tools</a><br />
|
||
|
|
<a href="li_Help.html">Help</a><br />
|
||
|
|
<a href="li_tests.html">tests</a><br />
|
||
|
|
<a href="li_main.html">main</a><br />
|
||
|
|
<br /><br />
|
||
|
|
<b>Files:</b><br />
|
||
|
|
<div class="package">
|
||
|
|
<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/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>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
|
||
|
|
|
||
|
|
<a name="top"></a>
|
||
|
|
<h1>Element index for package lists</h1>
|
||
|
|
[ <a href="elementindex_lists.html#a">a</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#b">b</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#c">c</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#d">d</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#e">e</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#f">f</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#g">g</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#i">i</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#l">l</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#m">m</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#n">n</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#p">p</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#r">r</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#s">s</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#t">t</a> ]
|
||
|
|
[ <a href="elementindex_lists.html#u">u</a> ]
|
||
|
|
|
||
|
|
<hr />
|
||
|
|
<a name="a"></a>
|
||
|
|
<div>
|
||
|
|
<h2>a</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$attrArray</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$attrArray">lamList::$attrArray</a><br> list of LDAP attributes</dd>
|
||
|
|
<dt><b>arrayLower</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionarrayLower">arrayLower()</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>add_attr_form.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_add_attr_form_php.html">add_attr_form.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>add_attr.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_add_attr_php.html">add_attr.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>add_oclass_form.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_add_oclass_form_php.html">add_oclass_form.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>add_oclass.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_add_oclass_php.html">add_oclass.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>add_value_form.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_add_value_form_php.html">add_value_form.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>add_value.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_add_value_php.html">add_value.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="b"></a>
|
||
|
|
<div>
|
||
|
|
<h2>b</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>build_initial_tree_icons</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionbuild_initial_tree_icons">build_initial_tree_icons()</a> (<b>subpackage:</b> tree)<br> Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="c"></a>
|
||
|
|
<div>
|
||
|
|
<h2>c</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>cmp_array</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodcmp_array">lamList::cmp_array()</a><br> Compare function used for usort-method</dd>
|
||
|
|
<dt><b>collapse.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_collapse_php.html">collapse.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>create_form.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_create_form_php.html">create_form.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>create.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_create_php.html">create.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>creation_template.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_creation_template_php.html">creation_template.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>custom.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_templates_creation_custom_php.html">custom.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="d"></a>
|
||
|
|
<div>
|
||
|
|
<h2>d</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$descArray</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$descArray">lamList::$descArray</a><br> list of attribute descriptions</dd>
|
||
|
|
<dt><b>dn_exists</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functiondn_exists">dn_exists()</a> (<b>subpackage:</b> tree)<br> Gets whether an entry exists based on its DN. If the entry exists, returns true. Otherwise returns false.</dd>
|
||
|
|
<dt><b>draw_create_link</b></dt>
|
||
|
|
<dd>in file tree.php, function <a href="lists/tree/_templates_tree_tree_php.html#functiondraw_create_link">draw_create_link()</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>draw_formatted_dn</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functiondraw_formatted_dn">draw_formatted_dn()</a> (<b>subpackage:</b> tree)<br> Gets a DN string using the user-configured tree_display_format string to format it.</dd>
|
||
|
|
<dt><b>draw_jpeg_photos</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functiondraw_jpeg_photos">draw_jpeg_photos()</a> (<b>subpackage:</b> tree)<br> Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.</dd>
|
||
|
|
<dt><b>draw_server_tree</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functiondraw_server_tree">draw_server_tree()</a> (<b>subpackage:</b> tree)<br> Prints the HTML of the tree view.</dd>
|
||
|
|
<dt><b>draw_tree_html</b></dt>
|
||
|
|
<dd>in file tree.php, function <a href="lists/tree/_templates_tree_tree_php.html#functiondraw_tree_html">draw_tree_html()</a> (<b>subpackage:</b> tree)<br> Recursively descend on the given dn and draw the tree in html</dd>
|
||
|
|
<dt><b>delete_attr.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_delete_attr_php.html">delete_attr.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>delete_form.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_delete_form_php.html">delete_form.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>delete.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_delete_php.html">delete.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>download_binary_attr.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_download_binary_attr_php.html">download_binary_attr.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="e"></a>
|
||
|
|
<div>
|
||
|
|
<h2>e</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$entries</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$entries">lamList::$entries</a><br> LDAP entries</dd>
|
||
|
|
<dt><b>edit.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_edit_php.html">edit.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>expand.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_expand_php.html">expand.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>export_form.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_export_form_php.html">export_form.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>export.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_export_php.html">export.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="f"></a>
|
||
|
|
<div>
|
||
|
|
<h2>f</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$filterText</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$filterText">lamList::$filterText</a><br> filter string to include in URL</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="g"></a>
|
||
|
|
<div>
|
||
|
|
<h2>g</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>get_attr_select_html</b></dt>
|
||
|
|
<dd>in file custom.php, function <a href="lists/tree/_templates_tree_templates_creation_custom_php.html#functionget_attr_select_html">get_attr_select_html()</a> (<b>subpackage:</b> tree)<br> Returns option values.</dd>
|
||
|
|
<dt><b>get_binary_attr_select_html</b></dt>
|
||
|
|
<dd>in file custom.php, function <a href="lists/tree/_templates_tree_templates_creation_custom_php.html#functionget_binary_attr_select_html">get_binary_attr_select_html()</a> (<b>subpackage:</b> tree)<br> Returns option values.</dd>
|
||
|
|
<dt><b>get_container</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionget_container">get_container()</a> (<b>subpackage:</b> tree)<br> Given a DN string, this returns the parent container portion of the string.</dd>
|
||
|
|
<dt><b>get_container_contents</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionget_container_contents">get_container_contents()</a> (<b>subpackage:</b> tree)<br> Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of child entries one level beneath the parent. For example, for the following tree:</dd>
|
||
|
|
<dt><b>get_enc_type</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionget_enc_type">get_enc_type()</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>get_entry_system_attrs</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionget_entry_system_attrs">get_entry_system_attrs()</a> (<b>subpackage:</b> tree)<br> Gets the operational attributes for an entry. Given a DN, this function fetches that entry's</dd>
|
||
|
|
<dt><b>get_icon</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionget_icon">get_icon()</a> (<b>subpackage:</b> tree)<br> Given a DN and server ID, this function reads the DN's objectClasses and</dd>
|
||
|
|
<dt><b>get_line_end_format</b></dt>
|
||
|
|
<dd>in file export_form.php, function <a href="lists/tree/_templates_tree_export_form_php.html#functionget_line_end_format">get_line_end_format()</a> (<b>subpackage:</b> tree)<br> Helper functoin for fetching the line end format.</dd>
|
||
|
|
<dt><b>get_object_attr</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionget_object_attr">get_object_attr()</a> (<b>subpackage:</b> tree)<br> Much like get_object_attrs(), but only returns the values for one attribute of an object. Example calls:</dd>
|
||
|
|
<dt><b>get_object_attrs</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionget_object_attrs">get_object_attrs()</a> (<b>subpackage:</b> tree)<br> Gets the attributes/values of an entry. Returns an associative array whose</dd>
|
||
|
|
<dt><b>get_rdn</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionget_rdn">get_rdn()</a> (<b>subpackage:</b> tree)<br> Given a DN string, this returns the 'RDN' portion of the string.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="i"></a>
|
||
|
|
<div>
|
||
|
|
<h2>i</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>initialize_session_tree</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functioninitialize_session_tree">initialize_session_tree()</a> (<b>subpackage:</b> tree)<br> Checks and fixes an initial session's tree cache if needed.</dd>
|
||
|
|
<dt><b>is_attr_binary</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionis_attr_binary">is_attr_binary()</a> (<b>subpackage:</b> tree)<br> Given an attribute name and server ID number, this function returns whether the attrbiute may contain binary data. This is useful for developers who wish to display the contents of an arbitrary attribute but don't want to dump binary data on the page.</dd>
|
||
|
|
<dt><b>is_attr_boolean</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionis_attr_boolean">is_attr_boolean()</a> (<b>subpackage:</b> tree)<br> Given an attribute name and server ID number, this function returns whether the attrbiute contains boolean data. This is useful for developers who wish to display the contents of a boolean attribute with a drop-down.</dd>
|
||
|
|
<dt><b>is_binary_option_required</b></dt>
|
||
|
|
<dd>in file add_attr.php, function <a href="lists/tree/_templates_tree_add_attr_php.html#functionis_binary_option_required">is_binary_option_required()</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>is_dn_attr</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionis_dn_attr">is_dn_attr()</a> (<b>subpackage:</b> tree)<br> Returns true if the attribute specified is required to take as input a DN.</dd>
|
||
|
|
<dt><b>is_jpeg_photo</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionis_jpeg_photo">is_jpeg_photo()</a> (<b>subpackage:</b> tree)<br> Used to determine if the specified attribute is indeed a jpegPhoto. If the specified attribute is one that houses jpeg data, true is returned. Otherwise this function returns false.</dd>
|
||
|
|
<dt><b>is_mail_string</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionis_mail_string">is_mail_string()</a> (<b>subpackage:</b> tree)<br> Get whether a string looks like an email address (user@example.com).</dd>
|
||
|
|
<dt><b>is_multi_line_attr</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionis_multi_line_attr">is_multi_line_attr()</a> (<b>subpackage:</b> tree)<br> Determines if an attribute's value can contain multiple lines. Attributes that fall in this multi-line category may be configured in config.php. Hence, this function accesses the global variable $multi_line_attributes;</dd>
|
||
|
|
<dt><b>is_url_string</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionis_url_string">is_url_string()</a> (<b>subpackage:</b> tree)<br> Get whether a string looks like a web URL (http://www.example.com/)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="l"></a>
|
||
|
|
<div>
|
||
|
|
<h2>l</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$labels</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$labels">lamList::$labels</a><br> list of account specific labels</dd>
|
||
|
|
<dt><b>lamGroupList</b></dt>
|
||
|
|
<dd>in file group.inc, class <a href="lists/lamGroupList.html">lamGroupList</a><br> Generates the list view.</dd>
|
||
|
|
<dt><b>lamGroupList</b></dt>
|
||
|
|
<dd>in file group.inc, method <a href="lists/lamGroupList.html#methodlamGroupList">lamGroupList::lamGroupList()</a><br> Constructor</dd>
|
||
|
|
<dt><b>lamHostList</b></dt>
|
||
|
|
<dd>in file host.inc, method <a href="lists/lamHostList.html#methodlamHostList">lamHostList::lamHostList()</a><br> Constructor</dd>
|
||
|
|
<dt><b>lamHostList</b></dt>
|
||
|
|
<dd>in file host.inc, class <a href="lists/lamHostList.html">lamHostList</a><br> Generates the list view.</dd>
|
||
|
|
<dt><b>lamList</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlamList">lamList::lamList()</a><br> Constructor</dd>
|
||
|
|
<dt><b>lamList</b></dt>
|
||
|
|
<dd>in file lists.inc, class <a href="lists/lamList.html">lamList</a><br> Generates the list view.</dd>
|
||
|
|
<dt><b>lamMailAliasList</b></dt>
|
||
|
|
<dd>in file mailAlias.inc, class <a href="lists/lamMailAliasList.html">lamMailAliasList</a><br> Generates the list view.</dd>
|
||
|
|
<dt><b>lamMailAliasList</b></dt>
|
||
|
|
<dd>in file mailAlias.inc, method <a href="lists/lamMailAliasList.html#methodlamMailAliasList">lamMailAliasList::lamMailAliasList()</a><br> Constructor</dd>
|
||
|
|
<dt><b>lamSmbDomainList</b></dt>
|
||
|
|
<dd>in file smbDomain.inc, method <a href="lists/lamSmbDomainList.html#methodlamSmbDomainList">lamSmbDomainList::lamSmbDomainList()</a><br> Constructor</dd>
|
||
|
|
<dt><b>lamSmbDomainList</b></dt>
|
||
|
|
<dd>in file smbDomain.inc, class <a href="lists/lamSmbDomainList.html">lamSmbDomainList</a><br> Generates the list view.</dd>
|
||
|
|
<dt><b>lamUserList</b></dt>
|
||
|
|
<dd>in file user.inc, class <a href="lists/lamUserList.html">lamUserList</a><br> Generates the list view.</dd>
|
||
|
|
<dt><b>lamUserList</b></dt>
|
||
|
|
<dd>in file user.inc, method <a href="lists/lamUserList.html#methodlamUserList">lamUserList::lamUserList()</a><br> Constructor</dd>
|
||
|
|
<dt><b>lists.inc</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/_lib_lists_inc.html">lists.inc</a></dd>
|
||
|
|
<dt><b>listBuildFilter</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistBuildFilter">lamList::listBuildFilter()</a><br> Builds the regular expressions from the filter values.</dd>
|
||
|
|
<dt><b>listDoPost</b></dt>
|
||
|
|
<dd>in file user.inc, method <a href="lists/lamUserList.html#methodlistDoPost">lamUserList::listDoPost()</a><br> Manages all POST actions (e.g. button pressed) for the account lists.</dd>
|
||
|
|
<dt><b>listDoPost</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistDoPost">lamList::listDoPost()</a><br> Manages all POST actions (e.g. button pressed) for the account lists.</dd>
|
||
|
|
<dt><b>listDrawNavigationBar</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistDrawNavigationBar">lamList::listDrawNavigationBar()</a><br> Draws a navigation bar to switch between pages</dd>
|
||
|
|
<dt><b>listFilterAccounts</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistFilterAccounts">lamList::listFilterAccounts()</a><br> Removes all entries which do not fit to the filter.</dd>
|
||
|
|
<dt><b>listGetAttributeDescriptionList</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistGetAttributeDescriptionList">lamList::listGetAttributeDescriptionList()</a><br> Returns an hash array containing with all attributes to be shown and their descriptions.</dd>
|
||
|
|
<dt><b>listGetParams</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistGetParams">lamList::listGetParams()</a><br> Sets some internal parameters.</dd>
|
||
|
|
<dt><b>listPrintButtons</b></dt>
|
||
|
|
<dd>in file user.inc, method <a href="lists/lamUserList.html#methodlistPrintButtons">lamUserList::listPrintButtons()</a><br> Prints the create, delete and PDF buttons.</dd>
|
||
|
|
<dt><b>listPrintButtons</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistPrintButtons">lamList::listPrintButtons()</a><br> Prints the create, delete and PDF buttons.</dd>
|
||
|
|
<dt><b>listPrintHeader</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistPrintHeader">lamList::listPrintHeader()</a><br> Prints the HTML head.</dd>
|
||
|
|
<dt><b>listPrintJavaScript</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistPrintJavaScript">lamList::listPrintJavaScript()</a><br> Prints JavaScript code needed for mouse-over effects.</dd>
|
||
|
|
<dt><b>listPrintTableBody</b></dt>
|
||
|
|
<dd>in file user.inc, method <a href="lists/lamUserList.html#methodlistPrintTableBody">lamUserList::listPrintTableBody()</a><br> Prints the entry list</dd>
|
||
|
|
<dt><b>listPrintTableBody</b></dt>
|
||
|
|
<dd>in file group.inc, method <a href="lists/lamGroupList.html#methodlistPrintTableBody">lamGroupList::listPrintTableBody()</a><br> Prints the entry list</dd>
|
||
|
|
<dt><b>listPrintTableBody</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistPrintTableBody">lamList::listPrintTableBody()</a><br> Prints the entry list</dd>
|
||
|
|
<dt><b>listPrintTableHeader</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistPrintTableHeader">lamList::listPrintTableHeader()</a><br> Prints the attribute and filter row at the account table head</dd>
|
||
|
|
<dt><b>listRefreshData</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistRefreshData">lamList::listRefreshData()</a><br> Rereads the entries from LDAP.</dd>
|
||
|
|
<dt><b>listShowOUSelection</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistShowOUSelection">lamList::listShowOUSelection()</a><br> Prints a combobox with possible sub-DNs.</dd>
|
||
|
|
<dt><b>listSort</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodlistSort">lamList::listSort()</a><br> Sorts an account list by a given attribute</dd>
|
||
|
|
<dt><b>list.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/_templates_lists_list_php.html">list.php</a></dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="m"></a>
|
||
|
|
<div>
|
||
|
|
<h2>m</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$maxPageEntries</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$maxPageEntries">lamList::$maxPageEntries</a><br> maximum count of entries per page</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="n"></a>
|
||
|
|
<div>
|
||
|
|
<h2>n</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>not_an_attr</b></dt>
|
||
|
|
<dd>in file add_attr_form.php, function <a href="lists/tree/_templates_tree_add_attr_form_php.html#functionnot_an_attr">not_an_attr()</a> (<b>subpackage:</b> tree)<br> Given an attribute $x, this returns true if it is NOT already specified in the current entry, returns false otherwise.</dd>
|
||
|
|
<dt><b>new_ou_template.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_templates_creation_new_ou_template_php.html">new_ou_template.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="p"></a>
|
||
|
|
<div>
|
||
|
|
<h2>p</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$page</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$page">lamList::$page</a><br> current page number</dd>
|
||
|
|
<dt><b>$possibleSuffixes</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$possibleSuffixes">lamList::$possibleSuffixes</a><br> list of possible LDAP suffixes(organizational units)</dd>
|
||
|
|
<dt><b>pla_compare_dns</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionpla_compare_dns">pla_compare_dns()</a> (<b>subpackage:</b> tree)<br> Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.</dd>
|
||
|
|
<dt><b>pla_explode_dn</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionpla_explode_dn">pla_explode_dn()</a> (<b>subpackage:</b> tree)<br> Explode a DN into an array of its RDN parts. This function is UTF-8 safe and replaces the buggy PHP ldap_explode_dn() which does not properly handle UTF-8 DNs and also causes segmentation faults with some inputs.</dd>
|
||
|
|
<dt><b>pla_ldap_search</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionpla_ldap_search">pla_ldap_search()</a> (<b>subpackage:</b> tree)<br> A handy ldap searching function very similar to PHP's ldap_search() with the following exceptions: Callers may specify a search scope and the return value is an array containing the search results rather than an LDAP result resource.</dd>
|
||
|
|
<dt><b>pla_rdelete</b></dt>
|
||
|
|
<dd>in file rdelete.php, function <a href="lists/tree/_templates_tree_rdelete_php.html#functionpla_rdelete">pla_rdelete()</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>pla_reverse_dn</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionpla_reverse_dn">pla_reverse_dn()</a> (<b>subpackage:</b> tree)<br> Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last</dd>
|
||
|
|
<dt><b>pretty_print_dn</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionpretty_print_dn">pretty_print_dn()</a> (<b>subpackage:</b> tree)<br> Returns an HTML-beautified version of a DN.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="r"></a>
|
||
|
|
<div>
|
||
|
|
<h2>r</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$refresh</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$refresh">lamList::$refresh</a><br> refresh page switch</dd>
|
||
|
|
<dt><b>real_attr_name</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionreal_attr_name">real_attr_name()</a> (<b>subpackage:</b> tree)<br> Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.</dd>
|
||
|
|
<dt><b>remove_aliases</b></dt>
|
||
|
|
<dd>in file custom.php, function <a href="lists/tree/_templates_tree_templates_creation_custom_php.html#functionremove_aliases">remove_aliases()</a> (<b>subpackage:</b> tree)<br> Removes attributes from the array that are aliases for eachother</dd>
|
||
|
|
<dt><b>rdelete.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_rdelete_php.html">rdelete.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>refresh.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_refresh_php.html">refresh.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="s"></a>
|
||
|
|
<div>
|
||
|
|
<h2>s</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$sortColumn</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$sortColumn">lamList::$sortColumn</a><br> sort column name</dd>
|
||
|
|
<dt><b>$suffix</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$suffix">lamList::$suffix</a><br> LDAP suffix</dd>
|
||
|
|
<dt><b>search_username</b></dt>
|
||
|
|
<dd>in file userlink.php, function <a href="lists/_templates_lists_userlink_php.html#functionsearch_username">search_username()</a><br> Searches LDAP for a specific user name (uid attribute) and returns its DN entry</dd>
|
||
|
|
<dt><b>showPage</b></dt>
|
||
|
|
<dd>in file lists.inc, method <a href="lists/lamList.html#methodshowPage">lamList::showPage()</a><br> Prints the HTML code to display the list view.</dd>
|
||
|
|
<dt><b>sortAttrs</b></dt>
|
||
|
|
<dd>in file tree.inc, function <a href="lists/tree/_lib_tree_inc.html#functionsortAttrs">sortAttrs()</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="t"></a>
|
||
|
|
<div>
|
||
|
|
<h2>t</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>$trans_primary</b></dt>
|
||
|
|
<dd>in file user.inc, variable <a href="lists/lamUserList.html#var$trans_primary">lamUserList::$trans_primary</a><br> Controls if GID number is translated to group name</dd>
|
||
|
|
<dt><b>$trans_primary_hash</b></dt>
|
||
|
|
<dd>in file user.inc, variable <a href="lists/lamUserList.html#var$trans_primary_hash">lamUserList::$trans_primary_hash</a><br> translates GID to group name</dd>
|
||
|
|
<dt><b>$type</b></dt>
|
||
|
|
<dd>in file lists.inc, variable <a href="lists/lamList.html#var$type">lamList::$type</a><br> Account type</dd>
|
||
|
|
<dt><b>tree.inc</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_lib_tree_inc.html">tree.inc</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>templates.inc</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_templates_templates_inc.html">templates.inc</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>tree.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_tree_php.html">tree.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>tree_view.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_tree_view_php.html">tree_view.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<hr />
|
||
|
|
<a name="u"></a>
|
||
|
|
<div>
|
||
|
|
<h2>u</h2>
|
||
|
|
<dl>
|
||
|
|
<dt><b>userlink.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/_templates_lists_userlink_php.html">userlink.php</a></dd>
|
||
|
|
<dt><b>update_confirm.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_update_confirm_php.html">update_confirm.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
<dt><b>update.php</b></dt>
|
||
|
|
<dd>procedural page <a href="lists/tree/_templates_tree_update_php.html">update.php</a> (<b>subpackage:</b> tree)</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<a href="elementindex_lists.html#top">top</a><br>
|
||
|
|
<div class="credit">
|
||
|
|
<hr />
|
||
|
|
Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a>
|
||
|
|
</div>
|
||
|
|
</td></tr></table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|