LDAPAccountManager/lam-web/developers/devel/phpdoc/elementindex_configuration....

316 lines
20 KiB
HTML
Raw Normal View History

2008-02-07 19:32:16 +00:00
<html>
<head>
<title>Package configuration Element Index</title>
<link rel="stylesheet" type="text/css" href="media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">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_Help.html">Help</a><br />
<a href="li_PDF.html">PDF</a><br />
<a href="li_lib.html">lib</a><br />
<a href="li_modules.html">modules</a><br />
<a href="li_types.html">types</a><br />
<a href="li_configuration.html">configuration</a><br />
<a href="li_tools.html">tools</a><br />
<a href="li_LDAP.html">LDAP</a><br />
<a href="li_lists.html">lists</a><br />
<a href="li_profiles.html">profiles</a><br />
<a href="li_selfService.html">selfService</a><br />
<a href="li_main.html">main</a><br />
<a href="li_tests.html">tests</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">
<a name="top"></a>
<h1>Element index for package configuration</h1>
[ <a href="elementindex_configuration.html#a">a</a> ]
[ <a href="elementindex_configuration.html#c">c</a> ]
[ <a href="elementindex_configuration.html#d">d</a> ]
[ <a href="elementindex_configuration.html#g">g</a> ]
[ <a href="elementindex_configuration.html#i">i</a> ]
[ <a href="elementindex_configuration.html#l">l</a> ]
[ <a href="elementindex_configuration.html#m">m</a> ]
[ <a href="elementindex_configuration.html#p">p</a> ]
[ <a href="elementindex_configuration.html#s">s</a> ]
[ <a href="elementindex_configuration.html#_">_</a> ]
<hr />
<a name="_"></a>
<div>
<h2>_</h2>
<dl>
<dt><b>__construct</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#method__construct">LAMConfig::__construct()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Loads preferences from config file</dd>
<dt><b>__construct</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMCfgMain.html#method__construct">LAMCfgMain::__construct()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Loads preferences from config file</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="a"></a>
<div>
<h2>a</h2>
<dl>
<dt><b>$allowedHosts</b></dt>
<dd>in file config.inc, variable <a href="configuration/LAMCfgMain.html#var$allowedHosts">LAMCfgMain::$allowedHosts</a><br>&nbsp;&nbsp;&nbsp;&nbsp;list of hosts which may access LAM</dd>
<dt><b>ACCESS_ALL</b></dt>
<dd>in file config.inc, class constant <a href="configuration/LAMConfig.html#constACCESS_ALL">LAMConfig::ACCESS_ALL</a></dd>
<dt><b>ACCESS_PASSWORD_CHANGE</b></dt>
<dd>in file config.inc, class constant <a href="configuration/LAMConfig.html#constACCESS_PASSWORD_CHANGE">LAMConfig::ACCESS_PASSWORD_CHANGE</a></dd>
<dt><b>ACCESS_READ_ONLY</b></dt>
<dd>in file config.inc, class constant <a href="configuration/LAMConfig.html#constACCESS_READ_ONLY">LAMConfig::ACCESS_READ_ONLY</a></dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="c"></a>
<div>
<h2>c</h2>
<dl>
<dt><b>checkChmod</b></dt>
<dd>in file config.inc, function <a href="configuration/_lib---config.inc.html#functioncheckChmod">checkChmod()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks whether a specific flag in the rights string is set.</dd>
<dt><b>checkPassword</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMCfgMain.html#methodcheckPassword">LAMCfgMain::checkPassword()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks if the given password matches.</dd>
<dt><b>check_Passwd</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodcheck_Passwd">LAMConfig::check_Passwd()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Checks if the given password matches.</dd>
<dt><b>config_showAccountModules</b></dt>
<dd>in file confmodules.php, function <a href="configuration/_templates---config---confmodules.php.html#functionconfig_showAccountModules">config_showAccountModules()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Displays the module selection boxes and checks if dependencies are fulfilled.</dd>
<dt><b>config.inc</b></dt>
<dd>procedural page <a href="configuration/_lib---config.inc.html">config.inc</a></dd>
<dt><b>conflogin.php</b></dt>
<dd>procedural page <a href="configuration/_templates---config---conflogin.php.html">conflogin.php</a></dd>
<dt><b>confmain.php</b></dt>
<dd>procedural page <a href="configuration/_templates---config---confmain.php.html">confmain.php</a></dd>
<dt><b>confmodules.php</b></dt>
<dd>procedural page <a href="configuration/_templates---config---confmodules.php.html">confmodules.php</a></dd>
<dt><b>conftypes.php</b></dt>
<dd>procedural page <a href="configuration/_templates---config---conftypes.php.html">conftypes.php</a></dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="d"></a>
<div>
<h2>d</h2>
<dl>
<dt><b>$default</b></dt>
<dd>in file config.inc, variable <a href="configuration/LAMCfgMain.html#var$default">LAMCfgMain::$default</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Default profile</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="g"></a>
<div>
<h2>g</h2>
<dl>
<dt><b>getAccessLevel</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodgetAccessLevel">LAMConfig::getAccessLevel()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the access level for this profile.</dd>
<dt><b>getConfigProfiles</b></dt>
<dd>in file config.inc, function <a href="configuration/_lib---config.inc.html#functiongetConfigProfiles">getConfigProfiles()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of string with all available configuration profiles (without .conf)</dd>
<dt><b>getName</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodgetName">LAMConfig::getName()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the config file</dd>
<dt><b>get_AccountModules</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_AccountModules">LAMConfig::get_AccountModules()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of all selected account modules</dd>
<dt><b>get_ActiveTypes</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_ActiveTypes">LAMConfig::get_ActiveTypes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of active account types.</dd>
<dt><b>get_Admins</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_Admins">LAMConfig::get_Admins()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of string with all admin names</dd>
<dt><b>get_Adminstring</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_Adminstring">LAMConfig::get_Adminstring()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns all admin users seperated by semicolons</dd>
<dt><b>get_cacheTimeout</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_cacheTimeout">LAMConfig::get_cacheTimeout()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the LDAP cache timeout in minutes</dd>
<dt><b>get_cacheTimeoutSec</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_cacheTimeoutSec">LAMConfig::get_cacheTimeoutSec()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the LDAP cache timeout in seconds</dd>
<dt><b>get_defaultLanguage</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_defaultLanguage">LAMConfig::get_defaultLanguage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the default language string</dd>
<dt><b>get_listAttributes</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_listAttributes">LAMConfig::get_listAttributes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the list of attributes to show in user list</dd>
<dt><b>get_moduleSettings</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_moduleSettings">LAMConfig::get_moduleSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of saved module settings</dd>
<dt><b>get_scriptPath</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_scriptPath">LAMConfig::get_scriptPath()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the path to the external script</dd>
<dt><b>get_scriptRights</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_scriptRights">LAMConfig::get_scriptRights()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the chmod value for new home directories.</dd>
<dt><b>get_scriptServers</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_scriptServers">LAMConfig::get_scriptServers()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the servers of the external script as a Array</dd>
<dt><b>get_ServerURL</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_ServerURL">LAMConfig::get_ServerURL()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the server address as string</dd>
<dt><b>get_Suffix</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_Suffix">LAMConfig::get_Suffix()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the LDAP suffix for the given account type</dd>
<dt><b>get_typeSettings</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodget_typeSettings">LAMConfig::get_typeSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of saved type settings</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="i"></a>
<div>
<h2>i</h2>
<dl>
<dt><b>isWritable</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodisWritable">LAMConfig::isWritable()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns if the file can be written on the filesystem.</dd>
<dt><b>index.php</b></dt>
<dd>procedural page <a href="configuration/_templates---config---index.php.html">index.php</a></dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="l"></a>
<div>
<h2>l</h2>
<dl>
<dt><b>$logDestination</b></dt>
<dd>in file config.inc, variable <a href="configuration/LAMCfgMain.html#var$logDestination">LAMCfgMain::$logDestination</a><br>&nbsp;&nbsp;&nbsp;&nbsp;log destination (&quot;SYSLOG&quot;:syslog, &quot;/...&quot;:file, &quot;NONE&quot;:none)</dd>
<dt><b>$logLevel</b></dt>
<dd>in file config.inc, variable <a href="configuration/LAMCfgMain.html#var$logLevel">LAMCfgMain::$logLevel</a><br>&nbsp;&nbsp;&nbsp;&nbsp;log level</dd>
<dt><b>LAMCfgMain</b></dt>
<dd>in file config.inc, class <a href="configuration/LAMCfgMain.html">LAMCfgMain</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This class manages config.cfg.</dd>
<dt><b>LAMConfig</b></dt>
<dd>in file config.inc, class <a href="configuration/LAMConfig.html">LAMConfig</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This class manages .conf files.</dd>
<dt><b>LAMVersion</b></dt>
<dd>in file config.inc, function <a href="configuration/_lib---config.inc.html#functionLAMVersion">LAMVersion()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the version number of this LAM installation.</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="m"></a>
<div>
<h2>m</h2>
<dl>
<dt><b>metaRefresh</b></dt>
<dd>in file config.inc, function <a href="configuration/_lib---config.inc.html#functionmetaRefresh">metaRefresh()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Prints a meta refresh page</dd>
<dt><b>mainlogin.php</b></dt>
<dd>procedural page <a href="configuration/_templates---config---mainlogin.php.html">mainlogin.php</a></dd>
<dt><b>mainmanage.php</b></dt>
<dd>procedural page <a href="configuration/_templates---config---mainmanage.php.html">mainmanage.php</a></dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="p"></a>
<div>
<h2>p</h2>
<dl>
<dt><b>profmanage.php</b></dt>
<dd>procedural page <a href="configuration/_templates---config---profmanage.php.html">profmanage.php</a></dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="s"></a>
<div>
<h2>s</h2>
<dl>
<dt><b>$sessionTimeout</b></dt>
<dd>in file config.inc, variable <a href="configuration/LAMCfgMain.html#var$sessionTimeout">LAMCfgMain::$sessionTimeout</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Time of inactivity before session times out (minutes)</dd>
<dt><b>save</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodsave">LAMConfig::save()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Saves preferences to config file</dd>
<dt><b>save</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMCfgMain.html#methodsave">LAMCfgMain::save()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Saves preferences to config file config.cfg</dd>
<dt><b>saveSettings</b></dt>
<dd>in file confmain.php, function <a href="configuration/_templates---config---confmain.php.html#functionsaveSettings">saveSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Saves the entered settings.</dd>
<dt><b>setAccessLevel</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodsetAccessLevel">LAMConfig::setAccessLevel()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the access level for this profile.</dd>
<dt><b>setlanguage</b></dt>
<dd>in file config.inc, function <a href="configuration/_lib---config.inc.html#functionsetlanguage">setlanguage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets language settings for automatic translation</dd>
<dt><b>setPassword</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMCfgMain.html#methodsetPassword">LAMCfgMain::setPassword()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets a new config password.</dd>
<dt><b>set_AccountModules</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_AccountModules">LAMConfig::set_AccountModules()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the selected account modules</dd>
<dt><b>set_ActiveTypes</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_ActiveTypes">LAMConfig::set_ActiveTypes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the list of active types.</dd>
<dt><b>set_Adminstring</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_Adminstring">LAMConfig::set_Adminstring()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the admin string</dd>
<dt><b>set_cacheTimeout</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_cacheTimeout">LAMConfig::set_cacheTimeout()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)</dd>
<dt><b>set_defaultLanguage</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_defaultLanguage">LAMConfig::set_defaultLanguage()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the default language string</dd>
<dt><b>set_listAttributes</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_listAttributes">LAMConfig::set_listAttributes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the list of attributes to show in user list</dd>
<dt><b>set_moduleSettings</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_moduleSettings">LAMConfig::set_moduleSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the settings for the account modules.</dd>
<dt><b>set_Passwd</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_Passwd">LAMConfig::set_Passwd()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the preferences wizard password</dd>
<dt><b>set_scriptPath</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_scriptPath">LAMConfig::set_scriptPath()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the path to the external script</dd>
<dt><b>set_scriptRights</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_scriptRights">LAMConfig::set_scriptRights()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the rights for the home directory.</dd>
<dt><b>set_scriptServers</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_scriptServers">LAMConfig::set_scriptServers()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the servers of the external script</dd>
<dt><b>set_ServerURL</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_ServerURL">LAMConfig::set_ServerURL()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the server address</dd>
<dt><b>set_Suffix</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_Suffix">LAMConfig::set_Suffix()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the LDAP suffix where accounts are saved</dd>
<dt><b>set_typeSettings</b></dt>
<dd>in file config.inc, method <a href="configuration/LAMConfig.html#methodset_typeSettings">LAMConfig::set_typeSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the settings for the account types.</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<div class="credit">
<hr />
Documentation generated on Thu, 07 Feb 2008 20:26:13 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>