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

370 lines
21 KiB
HTML
Raw Normal View History

2006-07-09 14:14:57 +00:00
<html>
<head>
<title>Package configuration Element Index</title>
<link rel="stylesheet" type="text/css" href="media/style.css">
</head>
<body>
<p align="center">
<script type="text/javascript"><!--
google_ad_client = "pub-4179059556107138";
google_alternate_ad_url = "http://lam.sourceforge.net/google_adsense_script.html";
google_ad_width = 728;
google_ad_height = 90;
google_ad_format = "728x90_as";
google_ad_type = "text_image";
google_ad_channel ="";
google_page_url = document.location;
google_color_border = "EEEEEE";
google_color_bg = "FFFFFF";
google_color_link = "0000FF";
google_color_url = "008000";
google_color_text = "000000";
//--></script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</p>
<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>
<div id="todolist">
<p><a href="todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="li_PDF.html">PDF</a><br />
<a href="li_lists.html">lists</a><br />
<a href="li_profiles.html">profiles</a><br />
<a href="li_LDAP.html">LDAP</a><br />
<a href="li_types.html">types</a><br />
<a href="li_lib.html">lib</a><br />
<a href="li_modules.html">modules</a><br />
<a href="li_configuration.html">configuration</a><br />
<a href="li_tools.html">tools</a><br />
<a href="li_Help.html">Help</a><br />
<a href="li_tests.html">tests</a><br />
<a href="li_main.html">main</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_profmanage_php.html"> profmanage.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="configuration/CfgMain.html">CfgMain</a><br />
<a href="configuration/Config.html">Config</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#f">f</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#r">r</a> ]
[ <a href="elementindex_configuration.html#s">s</a> ]
[ <a href="elementindex_configuration.html#t">t</a> ]
<hr />
<a name="a"></a>
<div>
<h2>a</h2>
<dl>
<dt><b>$activeTypes</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$activeTypes">Config::$activeTypes</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Active account types</dd>
<dt><b>$Admins</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$Admins">Config::$Admins</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Array of string: users with admin rights</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="c"></a>
<div>
<h2>c</h2>
<dl>
<dt><b>$cachetimeout</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$cachetimeout">Config::$cachetimeout</a><br>&nbsp;&nbsp;&nbsp;&nbsp;LDAP cache timeout</dd>
<dt><b>CfgMain</b></dt>
<dd>in file config.inc, method <a href="configuration/CfgMain.html#methodCfgMain">CfgMain::CfgMain()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Loads preferences from config file</dd>
<dt><b>CfgMain</b></dt>
<dd>in file config.inc, class <a href="configuration/CfgMain.html">CfgMain</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This class manages config.cfg.</dd>
<dt><b>Config</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodConfig">Config::Config()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Loads preferences from config file</dd>
<dt><b>Config</b></dt>
<dd>in file config.inc, class <a href="configuration/Config.html">Config</a><br>&nbsp;&nbsp;&nbsp;&nbsp;This class manages .conf files.</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/CfgMain.html#var$default">CfgMain::$default</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Default profile</dd>
<dt><b>$defaultLanguage</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$defaultLanguage">Config::$defaultLanguage</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Default language</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="f"></a>
<div>
<h2>f</h2>
<dl>
<dt><b>$file</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$file">Config::$file</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Name of configuration file</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="g"></a>
<div>
<h2>g</h2>
<dl>
<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>get_AccountModules</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodget_AccountModules">Config::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/Config.html#methodget_ActiveTypes">Config::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/Config.html#methodget_Admins">Config::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/Config.html#methodget_Adminstring">Config::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/Config.html#methodget_cacheTimeout">Config::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/Config.html#methodget_cacheTimeoutSec">Config::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/Config.html#methodget_defaultLanguage">Config::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/Config.html#methodget_listAttributes">Config::get_listAttributes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the list of attributes to show in user list</dd>
<dt><b>get_MaxListEntries</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodget_MaxListEntries">Config::get_MaxListEntries()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the maximum number of rows in user/group/host lists</dd>
<dt><b>get_moduleSettings</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodget_moduleSettings">Config::get_moduleSettings()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of saved module settings</dd>
<dt><b>get_Passwd</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodget_Passwd">Config::get_Passwd()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the password to access the preferences wizard</dd>
<dt><b>get_scriptPath</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodget_scriptPath">Config::get_scriptPath()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the path to the external script</dd>
<dt><b>get_scriptServer</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodget_scriptServer">Config::get_scriptServer()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns the server of the external script</dd>
<dt><b>get_ServerURL</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodget_ServerURL">Config::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/Config.html#methodget_Suffix">Config::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/Config.html#methodget_typeSettings">Config::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>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="l"></a>
<div>
<h2>l</h2>
<dl>
<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>$maxlistentries</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$maxlistentries">Config::$maxlistentries</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Maximum number of rows shown in user/group/host lists</dd>
<dt><b>$moduleSettings</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$moduleSettings">Config::$moduleSettings</a><br>&nbsp;&nbsp;&nbsp;&nbsp;module settings</dd>
<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>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="p"></a>
<div>
<h2>p</h2>
<dl>
<dt><b>$Passwd</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$Passwd">Config::$Passwd</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Password to edit preferences</dd>
<dt><b>$password</b></dt>
<dd>in file config.inc, variable <a href="configuration/CfgMain.html#var$password">CfgMain::$password</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Password to change config.cfg</dd>
<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="r"></a>
<div>
<h2>r</h2>
<dl>
<dt><b>reload</b></dt>
<dd>in file config.inc, method <a href="configuration/CfgMain.html#methodreload">CfgMain::reload()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Reloads preferences from config file config.cfg</dd>
<dt><b>reload</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodreload">Config::reload()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Reloads preferences from config file</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<hr />
<a name="s"></a>
<div>
<h2>s</h2>
<dl>
<dt><b>$scriptPath</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$scriptPath">Config::$scriptPath</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Path to external lamdaemon script on server where it is executed</dd>
<dt><b>$scriptServer</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$scriptServer">Config::$scriptServer</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Server where lamdaemon script is executed</dd>
<dt><b>$ServerURL</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$ServerURL">Config::$ServerURL</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Server address (e.g. ldap://127.0.0.1:389)</dd>
<dt><b>$settings</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$settings">Config::$settings</a><br>&nbsp;&nbsp;&nbsp;&nbsp;List of all settings in config file</dd>
<dt><b>save</b></dt>
<dd>in file config.inc, method <a href="configuration/CfgMain.html#methodsave">CfgMain::save()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Saves preferences to config file config.cfg</dd>
<dt><b>save</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodsave">Config::save()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Saves preferences to config file</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>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>set_AccountModules</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodset_AccountModules">Config::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/Config.html#methodset_ActiveTypes">Config::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/Config.html#methodset_Adminstring">Config::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/Config.html#methodset_cacheTimeout">Config::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/Config.html#methodset_defaultLanguage">Config::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/Config.html#methodset_listAttributes">Config::set_listAttributes()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the list of attributes to show in user list</dd>
<dt><b>set_MaxListEntries</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodset_MaxListEntries">Config::set_MaxListEntries()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the maximum number of rows in user/group/host lists</dd>
<dt><b>set_moduleSettings</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodset_moduleSettings">Config::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/Config.html#methodset_Passwd">Config::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/Config.html#methodset_scriptPath">Config::set_scriptPath()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the path to the external script</dd>
<dt><b>set_scriptServer</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodset_scriptServer">Config::set_scriptServer()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sets the server of the external script</dd>
<dt><b>set_ServerURL</b></dt>
<dd>in file config.inc, method <a href="configuration/Config.html#methodset_ServerURL">Config::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/Config.html#methodset_Suffix">Config::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/Config.html#methodset_typeSettings">Config::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>
<hr />
<a name="t"></a>
<div>
<h2>t</h2>
<dl>
<dt><b>$treesuffix</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$treesuffix">Config::$treesuffix</a><br>&nbsp;&nbsp;&nbsp;&nbsp;LDAP suffix for tree view</dd>
<dt><b>$typeSettings</b></dt>
<dd>in file config.inc, variable <a href="configuration/Config.html#var$typeSettings">Config::$typeSettings</a><br>&nbsp;&nbsp;&nbsp;&nbsp;type settings</dd>
</dl>
</div>
<a href="elementindex_configuration.html#top">top</a><br>
<div class="credit">
<hr />
Documentation generated on Tue, 07 Feb 2006 17:03:31 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
<p align="center">
<script type="text/javascript"><!--
google_ad_client = "pub-4179059556107138";
google_alternate_ad_url = "http://lam.sourceforge.net/google_adsense_script.html";
google_ad_width = 728;
google_ad_height = 90;
google_ad_format = "728x90_as";
google_ad_type = "text_image";
google_ad_channel ="";
google_page_url = document.location;
google_color_border = "EEEEEE";
google_color_bg = "FFFFFF";
google_color_link = "0000FF";
google_color_url = "008000";
google_color_text = "000000";
//--></script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</p>
</body>
</html>