1494 lines
45 KiB
HTML
1494 lines
45 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<title>Docs For Class LAMConfig</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">configuration</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_configuration.html" class="menu">class tree: configuration</a> ]
|
||
|
|
[ <a href="../elementindex_configuration.html" class="menu">index: configuration</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="../configuration/_lib_config_inc.html"> config.inc
|
||
|
|
</a><br>
|
||
|
|
<a href="../configuration/_templates_config_conflogin_php.html"> conflogin.php
|
||
|
|
</a><br>
|
||
|
|
<a href="../configuration/_templates_config_confmain_php.html"> confmain.php
|
||
|
|
</a><br>
|
||
|
|
<a href="../configuration/_templates_config_confmodules_php.html"> confmodules.php
|
||
|
|
</a><br>
|
||
|
|
<a href="../configuration/_templates_config_conftypes_php.html"> conftypes.php
|
||
|
|
</a><br>
|
||
|
|
<a href="../configuration/_templates_config_index_php.html"> index.php
|
||
|
|
</a><br>
|
||
|
|
<a href="../configuration/_templates_config_mainlogin_php.html"> mainlogin.php
|
||
|
|
</a><br>
|
||
|
|
<a href="../configuration/_templates_config_mainmanage_php.html"> mainmanage.php
|
||
|
|
</a><br>
|
||
|
|
<a href="../configuration/_templates_config_profmanage_php.html"> profmanage.php
|
||
|
|
</a><br>
|
||
|
|
</div><br />
|
||
|
|
|
||
|
|
|
||
|
|
<b>Classes:</b><br />
|
||
|
|
<div class="package">
|
||
|
|
<a href="../configuration/LAMCfgMain.html">LAMCfgMain</a><br />
|
||
|
|
<a href="../configuration/LAMConfig.html">LAMConfig</a><br />
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
|
||
|
|
|
||
|
|
<h1>Class: LAMConfig</h1>
|
||
|
|
Source Location: /lib/config.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">This class manages .conf files.</div><br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td valign="top">
|
||
|
|
<h3><a href="#class_vars">Variables</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$activeTypes">$activeTypes</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$Admins">$Admins</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$cachetimeout">$cachetimeout</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$defaultLanguage">$defaultLanguage</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$file">$file</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$maxlistentries">$maxlistentries</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$moduleSettings">$moduleSettings</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$Passwd">$Passwd</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$scriptPath">$scriptPath</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$scriptServer">$scriptServer</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$ServerURL">$ServerURL</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$settings">$settings</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$treesuffix">$treesuffix</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#var$typeSettings">$typeSettings</a></li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td valign="top">
|
||
|
|
<h3><a href="#class_methods">Methods</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodLAMConfig">LAMConfig</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_AccountModules">get_AccountModules</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_ActiveTypes">get_ActiveTypes</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_Admins">get_Admins</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_Adminstring">get_Adminstring</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_cacheTimeout">get_cacheTimeout</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_cacheTimeoutSec">get_cacheTimeoutSec</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_defaultLanguage">get_defaultLanguage</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_listAttributes">get_listAttributes</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_MaxListEntries">get_MaxListEntries</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_moduleSettings">get_moduleSettings</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_Passwd">get_Passwd</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_scriptPath">get_scriptPath</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_scriptServer">get_scriptServer</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_ServerURL">get_ServerURL</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_Suffix">get_Suffix</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodget_typeSettings">get_typeSettings</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodreload">reload</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodsave">save</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_AccountModules">set_AccountModules</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_ActiveTypes">set_ActiveTypes</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_Adminstring">set_Adminstring</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_cacheTimeout">set_cacheTimeout</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_defaultLanguage">set_defaultLanguage</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_listAttributes">set_listAttributes</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_MaxListEntries">set_MaxListEntries</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_moduleSettings">set_moduleSettings</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_Passwd">set_Passwd</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_scriptPath">set_scriptPath</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_scriptServer">set_scriptServer</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_ServerURL">set_ServerURL</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_Suffix">set_Suffix</a></li>
|
||
|
|
<li><a href="../configuration/LAMConfig.html#methodset_typeSettings">set_typeSettings</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 123]<br />
|
||
|
|
This class manages .conf files.<br /><br /></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$activeTypes"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$activeTypes = <span class="value"> "user,group,host,smbDomain"</span></h4>
|
||
|
|
<p>[line 169]</p>
|
||
|
|
Active account types<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$Admins"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$Admins = <span class="value"></span></h4>
|
||
|
|
<p>[line 129]</p>
|
||
|
|
Array of string: users with admin rights<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$cachetimeout"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$cachetimeout = <span class="value"></span></h4>
|
||
|
|
<p>[line 166]</p>
|
||
|
|
LDAP cache timeout<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$defaultLanguage"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$defaultLanguage = <span class="value"></span></h4>
|
||
|
|
<p>[line 141]</p>
|
||
|
|
Default language<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$file"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$file = <span class="value"></span></h4>
|
||
|
|
<p>[line 172]</p>
|
||
|
|
Name of configuration file<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$maxlistentries"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$maxlistentries = <span class="value"></span></h4>
|
||
|
|
<p>[line 138]</p>
|
||
|
|
Maximum number of rows shown in user/group/host lists<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$moduleSettings"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$moduleSettings = <span class="value">array()</span></h4>
|
||
|
|
<p>[line 144]</p>
|
||
|
|
module settings<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$Passwd"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$Passwd = <span class="value"></span></h4>
|
||
|
|
<p>[line 132]</p>
|
||
|
|
Password to edit preferences<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$scriptPath"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$scriptPath = <span class="value"></span></h4>
|
||
|
|
<p>[line 155]</p>
|
||
|
|
Path to external lamdaemon script on server where it is executed<br /><br /><p>This is used for managing quota and home directories. optional setting, may not be defined</p><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$scriptServer"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$scriptServer = <span class="value"></span></h4>
|
||
|
|
<p>[line 163]</p>
|
||
|
|
Server where lamdaemon script is executed<br /><br /><p>This is used for managing quota and home directories. optional setting, may not be defined</p><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$ServerURL"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$ServerURL = <span class="value"></span></h4>
|
||
|
|
<p>[line 126]</p>
|
||
|
|
Server address (e.g. ldap://127.0.0.1:389)<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$settings"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$settings = <span class="value">array("ServerURL", "Passwd", "Admins", "treesuffix", "maxlistentries",<br>
|
||
|
|
"defaultLanguage", "scriptPath", "scriptServer", "cachetimeout",<br>
|
||
|
|
"modules", "activeTypes", "types")</span></h4>
|
||
|
|
<p>[line 175]</p>
|
||
|
|
List of all settings in config file<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$treesuffix"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$treesuffix = <span class="value"></span></h4>
|
||
|
|
<p>[line 135]</p>
|
||
|
|
LDAP suffix for tree view<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
<a name="var$typeSettings"></a>
|
||
|
|
<p></p>
|
||
|
|
<h4>$typeSettings = <span class="value">array()</span></h4>
|
||
|
|
<p>[line 147]</p>
|
||
|
|
type settings<br /><br />
|
||
|
|
<br />
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>Type:</b> </td>
|
||
|
|
<td>mixed</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br /><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
||
|
|
</div><br />
|
||
|
|
|
||
|
|
<hr />
|
||
|
|
<a name="class_methods"></a>
|
||
|
|
<h3>Class Methods</h3>
|
||
|
|
<div class="tags">
|
||
|
|
|
||
|
|
<hr />
|
||
|
|
<a name="methodLAMConfig"></a>
|
||
|
|
<h3>constructor LAMConfig <span class="smalllinenumber">[line 185]</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>LAMConfig LAMConfig(
|
||
|
|
[integer
|
||
|
|
$file = 0])</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Loads preferences from config file<br /><br /><br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td class="type">integer </td>
|
||
|
|
<td><b>$file</b> </td>
|
||
|
|
<td>Index number in config file array</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_AccountModules"></a>
|
||
|
|
<h3>method get_AccountModules <span class="smalllinenumber">[line 615]</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 get_AccountModules(
|
||
|
|
string
|
||
|
|
$scope)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns an array of all selected account modules<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>user modules</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>$scope</b> </td>
|
||
|
|
<td>account type</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_ActiveTypes"></a>
|
||
|
|
<h3>method get_ActiveTypes <span class="smalllinenumber">[line 671]</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 get_ActiveTypes(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns a list of active account types.<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 types</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_Admins"></a>
|
||
|
|
<h3>method get_Admins <span class="smalllinenumber">[line 376]</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 get_Admins(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns an array of string with all admin names<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>the admin names</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_Adminstring"></a>
|
||
|
|
<h3>method get_Adminstring <span class="smalllinenumber">[line 385]</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 get_Adminstring(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns all admin users seperated by semicolons<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>the admin string</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_cacheTimeout"></a>
|
||
|
|
<h3>method get_cacheTimeout <span class="smalllinenumber">[line 581]</span></h3>
|
||
|
|
<div class="function">
|
||
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
||
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
||
|
|
<code>integer get_cacheTimeout(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the LDAP cache timeout in minutes<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>cache time</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_cacheTimeoutSec"></a>
|
||
|
|
<h3>method get_cacheTimeoutSec <span class="smalllinenumber">[line 591]</span></h3>
|
||
|
|
<div class="function">
|
||
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
||
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
||
|
|
<code>integer get_cacheTimeoutSec(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the LDAP cache timeout in seconds<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>cache time</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_defaultLanguage"></a>
|
||
|
|
<h3>method get_defaultLanguage <span class="smalllinenumber">[line 514]</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 get_defaultLanguage(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the default language string<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>default language</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_listAttributes"></a>
|
||
|
|
<h3>method get_listAttributes <span class="smalllinenumber">[line 467]</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 get_listAttributes(
|
||
|
|
string
|
||
|
|
$scope)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the list of attributes to show in user list<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>the attribute list</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>$scope</b> </td>
|
||
|
|
<td>account type</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_MaxListEntries"></a>
|
||
|
|
<h3>method get_MaxListEntries <span class="smalllinenumber">[line 493]</span></h3>
|
||
|
|
<div class="function">
|
||
|
|
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
|
||
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
|
||
|
|
<code>integer get_MaxListEntries(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the maximum number of rows in user/group/host lists<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>maximum number</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_moduleSettings"></a>
|
||
|
|
<h3>method get_moduleSettings <span class="smalllinenumber">[line 662]</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 get_moduleSettings(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns a list of saved module settings<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 settings: array(name => value)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_Passwd"></a>
|
||
|
|
<h3>method get_Passwd <span class="smalllinenumber">[line 409]</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 get_Passwd(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the password to access the preferences wizard<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>the password</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_scriptPath"></a>
|
||
|
|
<h3>method get_scriptPath <span class="smalllinenumber">[line 535]</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 get_scriptPath(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the path to the external script<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>script path</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_scriptServer"></a>
|
||
|
|
<h3>method get_scriptServer <span class="smalllinenumber">[line 557]</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 get_scriptServer(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the server of the external script<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>script server</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_ServerURL"></a>
|
||
|
|
<h3>method get_ServerURL <span class="smalllinenumber">[line 355]</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 get_ServerURL(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the server address as string<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>server address</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_Suffix"></a>
|
||
|
|
<h3>method get_Suffix <span class="smalllinenumber">[line 431]</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 get_Suffix(
|
||
|
|
string
|
||
|
|
$scope)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns the LDAP suffix for the given account type<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>the LDAP suffix</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>$scope</b> </td>
|
||
|
|
<td>account type</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodget_typeSettings"></a>
|
||
|
|
<h3>method get_typeSettings <span class="smalllinenumber">[line 702]</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 get_typeSettings(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Returns a list of saved type settings<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 settings: array(name => value)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodreload"></a>
|
||
|
|
<h3>method reload <span class="smalllinenumber">[line 200]</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>boolean reload(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Reloads preferences from config file<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if file was readable</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodsave"></a>
|
||
|
|
<h3>method save <span class="smalllinenumber">[line 258]</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 save(
|
||
|
|
)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Saves preferences to config file<br /><br /><br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_AccountModules"></a>
|
||
|
|
<h3>method set_AccountModules <span class="smalllinenumber">[line 631]</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>boolean set_AccountModules(
|
||
|
|
array
|
||
|
|
$modules, string
|
||
|
|
$scope)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the selected account modules<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $modules has correct format</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td class="type">array </td>
|
||
|
|
<td><b>$modules</b> </td>
|
||
|
|
<td>array with module names (not aliases!)</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type">string </td>
|
||
|
|
<td><b>$scope</b> </td>
|
||
|
|
<td>account type</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_ActiveTypes"></a>
|
||
|
|
<h3>method set_ActiveTypes <span class="smalllinenumber">[line 681]</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 set_ActiveTypes(
|
||
|
|
array
|
||
|
|
$types)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the list of active types.<br /><br /><br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td class="type">array </td>
|
||
|
|
<td><b>$types</b> </td>
|
||
|
|
<td>list of types</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_Adminstring"></a>
|
||
|
|
<h3>method set_Adminstring <span class="smalllinenumber">[line 395]</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>boolean set_Adminstring(
|
||
|
|
string
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the admin string<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</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>new admin string that contains all admin users seperated by semicolons</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_cacheTimeout"></a>
|
||
|
|
<h3>method set_cacheTimeout <span class="smalllinenumber">[line 601]</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>boolean set_cacheTimeout(
|
||
|
|
integer
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td class="type">integer </td>
|
||
|
|
<td><b>$value</b> </td>
|
||
|
|
<td>new cache timeout</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_defaultLanguage"></a>
|
||
|
|
<h3>method set_defaultLanguage <span class="smalllinenumber">[line 524]</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>boolean set_defaultLanguage(
|
||
|
|
string
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the default language string<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</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>new default language</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_listAttributes"></a>
|
||
|
|
<h3>method set_listAttributes <span class="smalllinenumber">[line 478]</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>boolean set_listAttributes(
|
||
|
|
string
|
||
|
|
$value, string
|
||
|
|
$scope)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the list of attributes to show in user list<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</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>new attribute string</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type">string </td>
|
||
|
|
<td><b>$scope</b> </td>
|
||
|
|
<td>account type</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_MaxListEntries"></a>
|
||
|
|
<h3>method set_MaxListEntries <span class="smalllinenumber">[line 503]</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>boolean set_MaxListEntries(
|
||
|
|
integer
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the maximum number of rows in user/group/host lists<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td class="type">integer </td>
|
||
|
|
<td><b>$value</b> </td>
|
||
|
|
<td>new maximum value</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_moduleSettings"></a>
|
||
|
|
<h3>method set_moduleSettings <span class="smalllinenumber">[line 651]</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>boolean set_moduleSettings(
|
||
|
|
array
|
||
|
|
$settings)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the settings for the account modules.<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $settings has correct format</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td class="type">array </td>
|
||
|
|
<td><b>$settings</b> </td>
|
||
|
|
<td>list of module setting array(name => value)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_Passwd"></a>
|
||
|
|
<h3>method set_Passwd <span class="smalllinenumber">[line 419]</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>boolean set_Passwd(
|
||
|
|
string
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the preferences wizard password<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</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>new password</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_scriptPath"></a>
|
||
|
|
<h3>method set_scriptPath <span class="smalllinenumber">[line 545]</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>boolean set_scriptPath(
|
||
|
|
string
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the path to the external script<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</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>new script path</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_scriptServer"></a>
|
||
|
|
<h3>method set_scriptServer <span class="smalllinenumber">[line 567]</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>boolean set_scriptServer(
|
||
|
|
string
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the server of the external script<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</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>new script server</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_ServerURL"></a>
|
||
|
|
<h3>method set_ServerURL <span class="smalllinenumber">[line 365]</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>boolean set_ServerURL(
|
||
|
|
string
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the server address<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</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>new server address</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_Suffix"></a>
|
||
|
|
<h3>method set_Suffix <span class="smalllinenumber">[line 447]</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>boolean set_Suffix(
|
||
|
|
string
|
||
|
|
$scope, string
|
||
|
|
$value)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the LDAP suffix where accounts are saved<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $value has correct format</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>$scope</b> </td>
|
||
|
|
<td>account type</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="type">string </td>
|
||
|
|
<td><b>$value</b> </td>
|
||
|
|
<td>new LDAP suffix</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
<hr />
|
||
|
|
<a name="methodset_typeSettings"></a>
|
||
|
|
<h3>method set_typeSettings <span class="smalllinenumber">[line 691]</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>boolean set_typeSettings(
|
||
|
|
array
|
||
|
|
$settings)</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</td></tr></table><br />
|
||
|
|
|
||
|
|
Sets the settings for the account types.<br /><br /><br /><br />
|
||
|
|
<h4>Tags:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td><b>return:</b> </td><td>true if $settings has correct format</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<br /><br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters:</h4>
|
||
|
|
<div class="tags">
|
||
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
||
|
|
<tr>
|
||
|
|
<td class="type">array </td>
|
||
|
|
<td><b>$settings</b> </td>
|
||
|
|
<td>list of type setting array(name => value)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><br />
|
||
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
||
|
|
</div>
|
||
|
|
</div><br />
|
||
|
|
|
||
|
|
|
||
|
|
<div class="credit">
|
||
|
|
<hr />
|
||
|
|
Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a>
|
||
|
|
</div>
|
||
|
|
</td></tr></table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|