1442 lines
44 KiB
HTML
1442 lines
44 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_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="../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_consts">Constants</a></h3>
|
|
<ul>
|
|
<li><a href="../configuration/LAMConfig.html#constACCESS_ALL">ACCESS_ALL</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#constACCESS_PASSWORD_CHANGE">ACCESS_PASSWORD_CHANGE</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#constACCESS_READ_ONLY">ACCESS_READ_ONLY</a></li>
|
|
</ul>
|
|
</td>
|
|
|
|
<td valign="top">
|
|
<h3><a href="#class_methods">Methods</a></h3>
|
|
<ul>
|
|
<li><a href="../configuration/LAMConfig.html#method__construct">__construct</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodcheck_Passwd">check_Passwd</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodgetAccessLevel">getAccessLevel</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodgetName">getName</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_moduleSettings">get_moduleSettings</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodget_scriptPath">get_scriptPath</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodget_scriptRights">get_scriptRights</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodget_scriptServers">get_scriptServers</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#methodisWritable">isWritable</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodsave">save</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodsetAccessLevel">setAccessLevel</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_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_scriptRights">set_scriptRights</a></li>
|
|
<li><a href="../configuration/LAMConfig.html#methodset_scriptServers">set_scriptServers</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 164]<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_methods"></a>
|
|
<h3>Class Methods</h3>
|
|
<div class="tags">
|
|
|
|
<hr />
|
|
<a name="method__construct"></a>
|
|
<h3>constructor __construct <span class="smalllinenumber">[line 234]</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 __construct(
|
|
[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="methodcheck_Passwd"></a>
|
|
<h3>method check_Passwd <span class="smalllinenumber">[line 487]</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 check_Passwd(
|
|
String
|
|
$password)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Checks if the given password matches.<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 matches</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>$password</b> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodgetAccessLevel"></a>
|
|
<h3>method getAccessLevel <span class="smalllinenumber">[line 861]</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>int getAccessLevel(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the access level for this profile.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>level</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 403]</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 name of the 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>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="methodget_AccountModules"></a>
|
|
<h3>method get_AccountModules <span class="smalllinenumber">[line 765]</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>
|
|
<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>$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 821]</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>
|
|
<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="methodget_Admins"></a>
|
|
<h3>method get_Admins <span class="smalllinenumber">[line 453]</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>
|
|
<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="methodget_Adminstring"></a>
|
|
<h3>method get_Adminstring <span class="smalllinenumber">[line 462]</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>
|
|
<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="methodget_cacheTimeout"></a>
|
|
<h3>method get_cacheTimeout <span class="smalllinenumber">[line 731]</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>
|
|
<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="methodget_cacheTimeoutSec"></a>
|
|
<h3>method get_cacheTimeoutSec <span class="smalllinenumber">[line 741]</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>
|
|
<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="methodget_defaultLanguage"></a>
|
|
<h3>method get_defaultLanguage <span class="smalllinenumber">[line 600]</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>
|
|
<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="methodget_listAttributes"></a>
|
|
<h3>method get_listAttributes <span class="smalllinenumber">[line 574]</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>
|
|
<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>$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_moduleSettings"></a>
|
|
<h3>method get_moduleSettings <span class="smalllinenumber">[line 812]</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>
|
|
<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="methodget_scriptPath"></a>
|
|
<h3>method get_scriptPath <span class="smalllinenumber">[line 621]</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>
|
|
<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="methodget_scriptRights"></a>
|
|
<h3>method get_scriptRights <span class="smalllinenumber">[line 704]</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_scriptRights(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the chmod value for new home directories.<br /><br /><br /><br />
|
|
<h4>Tags:</h4>
|
|
<div class="tags">
|
|
<table border="0" cellspacing="0" cellpadding="0">
|
|
<tr>
|
|
<td><b>return:</b> </td><td>rights</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="methodget_scriptServers"></a>
|
|
<h3>method get_scriptServers <span class="smalllinenumber">[line 643]</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_scriptServers(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns the servers of the external script as a Array<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 servers</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="methodget_ServerURL"></a>
|
|
<h3>method get_ServerURL <span class="smalllinenumber">[line 432]</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>
|
|
<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="methodget_Suffix"></a>
|
|
<h3>method get_Suffix <span class="smalllinenumber">[line 538]</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>
|
|
<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>$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 852]</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>
|
|
<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="methodisWritable"></a>
|
|
<h3>method isWritable <span class="smalllinenumber">[line 412]</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 isWritable(
|
|
)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Returns if the file can be written on the filesystem.<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 is writable</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="methodsave"></a>
|
|
<h3>method save <span class="smalllinenumber">[line 307]</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 />
|
|
<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 />
|
|
|
|
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodsetAccessLevel"></a>
|
|
<h3>method setAccessLevel <span class="smalllinenumber">[line 870]</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 setAccessLevel(
|
|
int
|
|
$level)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Sets the access level for this profile.<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">int </td>
|
|
<td><b>$level</b> </td>
|
|
<td>level</td>
|
|
</tr>
|
|
</table>
|
|
</div><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 781]</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>
|
|
<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">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 831]</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>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">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 472]</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>
|
|
<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>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 751]</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>
|
|
<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">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 610]</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>
|
|
<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>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 585]</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>
|
|
<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>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_moduleSettings"></a>
|
|
<h3>method set_moduleSettings <span class="smalllinenumber">[line 801]</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>
|
|
<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">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 507]</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>
|
|
<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>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 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_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>
|
|
<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>new script path</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodset_scriptRights"></a>
|
|
<h3>method set_scriptRights <span class="smalllinenumber">[line 715]</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_scriptRights(
|
|
string
|
|
$chmod)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Sets the rights for the home directory.<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 values has correct format</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>$chmod</b> </td>
|
|
<td>the rights</td>
|
|
</tr>
|
|
</table>
|
|
</div><br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div>
|
|
</div>
|
|
<hr />
|
|
<a name="methodset_scriptServers"></a>
|
|
<h3>method set_scriptServers <span class="smalllinenumber">[line 653]</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_scriptServers(
|
|
string
|
|
$value)</code>
|
|
</td></tr></table>
|
|
</td></tr></table><br />
|
|
|
|
Sets the servers 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>
|
|
<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>new script servers</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 442]</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>
|
|
<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>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 554]</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>
|
|
<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>$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 841]</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>
|
|
<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">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 />
|
|
|
|
<hr />
|
|
<a name="class_constss"></a>
|
|
<h3>Class Constants</h3>
|
|
<div class="tags">
|
|
<a name="constACCESS_ALL"></a>
|
|
<p></p>
|
|
<h4>ACCESS_ALL = <span class="value"> 100</span></h4>
|
|
<p>[line 166]</p>
|
|
|
|
<br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
|
<a name="constACCESS_PASSWORD_CHANGE"></a>
|
|
<p></p>
|
|
<h4>ACCESS_PASSWORD_CHANGE = <span class="value"> 20</span></h4>
|
|
<p>[line 167]</p>
|
|
|
|
<br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
|
<a name="constACCESS_READ_ONLY"></a>
|
|
<p></p>
|
|
<h4>ACCESS_READ_ONLY = <span class="value"> 0</span></h4>
|
|
<p>[line 168]</p>
|
|
|
|
<br />
|
|
<div class="top">[ <a href="#top">Top</a> ]</div><br />
|
|
</div><br />
|
|
|
|
<div class="credit">
|
|
<hr />
|
|
Documentation generated on Thu, 07 Feb 2008 20:26:22 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
|
|
</div>
|
|
</td></tr></table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html> |