461 lines
15 KiB
HTML
461 lines
15 KiB
HTML
<html>
|
|
<head>
|
|
<title>Docs For Class lamListOption</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: lamListOption</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 list configuration option.</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/lamListOption.html#method__construct">__construct</a></li>
|
|
<li><a href="../lists/lamListOption.html#methodfillFromPostData">fillFromPostData</a></li>
|
|
<li><a href="../lists/lamListOption.html#methodgetID">getID</a></li>
|
|
<li><a href="../lists/lamListOption.html#methodgetMetaHTML">getMetaHTML</a></li>
|
|
<li><a href="../lists/lamListOption.html#methodgetValue">getValue</a></li>
|
|
<li><a href="../lists/lamListOption.html#methodsetValue">setValue</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/lamBooleanListOption.html">lamBooleanListOption</a></dt>
|
|
<dd>Boolean option for list configuration.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../lists/lamSelectListOption.html">lamSelectListOption</a></dt>
|
|
<dd>Boolean option for list configuration.</dd>
|
|
</dl>
|
|
</div>
|
|
</td>
|
|
|
|
|
|
|
|
|
|
</tr></table>
|
|
<hr />
|
|
|
|
<a name="class_details"></a>
|
|
<h3>Class Details</h3>
|
|
<div class="tags">
|
|
[line 998]<br />
|
|
Represents a list configuration option.<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>
|
|
<tr>
|
|
<td><b>abstract:</b> </td><td></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 1010]</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>lamConfigOption __construct(
|
|
String
|
|
$ID)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Creates a new config option.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>config option</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/lamBooleanListOption.html#method__construct">lamBooleanListOption::__construct()</a></dt>
|
|
<dd>Creates a new boolean option.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../lists/lamSelectListOption.html#method__construct">lamSelectListOption::__construct()</a></dt>
|
|
<dd>Creates a new selection list option.</dd>
|
|
</dl>
|
|
</p>
|
|
|
|
<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>unique ID</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodfillFromPostData"></a>
|
|
<h3>method fillFromPostData <span class="smalllinenumber">[line 1028]</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 fillFromPostData(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Fills the config option from POST data.<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 StatusMessages (array(<type>, <head line>, <body>))</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>abstract:</b> </td><td></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/lamBooleanListOption.html#methodfillFromPostData">lamBooleanListOption::fillFromPostData()</a></dt>
|
|
<dd>Fills the config option from POST data.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../lists/lamSelectListOption.html#methodfillFromPostData">lamSelectListOption::fillFromPostData()</a></dt>
|
|
<dd>Fills the config option from POST data.</dd>
|
|
</dl>
|
|
</p>
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetID"></a>
|
|
<h3>method getID <span class="smalllinenumber">[line 1019]</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 getID(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the option ID.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>ID</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="methodgetMetaHTML"></a>
|
|
<h3>method getMetaHTML <span class="smalllinenumber">[line 1056]</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 getMetaHTML(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the meta HTML data to display this option.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>meta HTML</td>
|
|
</tr>
|
|
<tr>
|
|
<td><b>abstract:</b> </td><td></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/lamBooleanListOption.html#methodgetMetaHTML">lamBooleanListOption::getMetaHTML()</a></dt>
|
|
<dd>Returns the meta HTML data to display this option.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt><a href="../lists/lamSelectListOption.html#methodgetMetaHTML">lamSelectListOption::getMetaHTML()</a></dt>
|
|
<dd>Returns the meta HTML data to display this option.</dd>
|
|
</dl>
|
|
</p>
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetValue"></a>
|
|
<h3>method getValue <span class="smalllinenumber">[line 1035]</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 getValue(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the option value. The value must not contain "=" and ";".<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>value</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="methodsetValue"></a>
|
|
<h3>method setValue <span class="smalllinenumber">[line 1044]</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 setValue(
|
|
String
|
|
$value)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Sets the config option value. The value must not contain "=" and ";".<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 />
|
|
|
|
|
|
<h4>Parameters:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td class="type">String </td>
|
|
<td><b>$value</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
</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> |