357 lines
12 KiB
HTML
357 lines
12 KiB
HTML
<html>
|
|
<head>
|
|
<title>Docs For Class lamListTool</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_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---changePassword.php.html"> changePassword.php
|
|
</a><br>
|
|
<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: lamListTool</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">Represents a tool which can be included in the account lists.</div><br /><br />
|
|
<h4>Author(s):</h4>
|
|
<ul>
|
|
<li>Roland Gruber</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
|
|
<td valign="top">
|
|
<h3><a href="#class_methods">Methods</a></h3>
|
|
<ul>
|
|
<li><a href="../lists/lamListTool.html#method__construct">__construct</a></li>
|
|
<li><a href="../lists/lamListTool.html#methodgetImage">getImage</a></li>
|
|
<li><a href="../lists/lamListTool.html#methodgetLinkTarget">getLinkTarget</a></li>
|
|
<li><a href="../lists/lamListTool.html#methodgetName">getName</a></li>
|
|
</ul>
|
|
</td>
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<table width="100%" border="0"><tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<a name="class_details"></a>
|
|
<h3>Class Details</h3>
|
|
<div class="tags">
|
|
[line 940]<br />
|
|
Represents a tool which can be included in the account lists.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>author:</b> </td><td>Roland Gruber</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div><br /><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
|
|
|
|
|
<hr />
|
|
<a name="class_methods"></a>
|
|
<h3>Class Methods</h3>
|
|
<div class="tags">
|
|
|
|
<hr />
|
|
<a name="method__construct"></a>
|
|
<h3>constructor __construct <span class="smalllinenumber">[line 954]</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/lamListTool.html">lamListTool</a> __construct(
|
|
String
|
|
$name, String
|
|
$image, String
|
|
$target)</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>tool object</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>access:</b> </td><td>public</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">String </td>
|
|
<td><b>$name</b> </td>
|
|
<td>tool name</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">String </td>
|
|
<td><b>$image</b> </td>
|
|
<td>image file</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="type">String </td>
|
|
<td><b>$target</b> </td>
|
|
<td>target page</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetImage"></a>
|
|
<h3>method getImage <span class="smalllinenumber">[line 966]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>String getImage(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the name of the tool image.<br /><br /><p>The image is returned without path (e.g. mytool.png). All images must reside in the graphics folder.</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>image name</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>access:</b> </td><td>public</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetLinkTarget"></a>
|
|
<h3>method getLinkTarget <span class="smalllinenumber">[line 986]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>String getLinkTarget(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.<br /><br /><p>The target page will be opened with two GET parameters: DN and type (e.g. user)</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>page file (e.g. 'mytool.php')</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>access:</b> </td><td>public</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<br /><br />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetName"></a>
|
|
<h3>method getName <span class="smalllinenumber">[line 976]</span></h3>
|
|
<div class="function">
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
|
<code>String getName(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the tool name.<br /><br /><p>This is used for the tool tip.</p><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>name</td>
|
|
</tr>
|
|
<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 />
|
|
|
|
|
|
<div class="credit">
|
|
<hr />
|
|
Documentation generated on Sun, 06 Jan 2008 18:59:15 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
|
|
</div>
|
|
</td></tr></table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html> |