2006-11-15 17:12:15 +00:00
< 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" >
2007-11-04 11:19:11 +00:00
[ < a href = "../classtrees_configuration.html" class = "menu" > class tree: configuration< / a > ]
2006-11-15 17:12:15 +00:00
[ < a href = "../elementindex_configuration.html" class = "menu" > index: configuration< / a > ]
2007-11-04 11:19:11 +00:00
[ < a href = "../elementindex.html" class = "menu" > all elements< / a > ]
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< p > < a href = "../ric_README.html" > README< / a > < / p >
2006-11-15 17:12:15 +00:00
< / 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" >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_lib---config.inc.html" > config.inc
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_templates---config---conflogin.php.html" > conflogin.php
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_templates---config---confmain.php.html" > confmain.php
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_templates---config---confmodules.php.html" > confmodules.php
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_templates---config---conftypes.php.html" > conftypes.php
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_templates---config---index.php.html" > index.php
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_templates---config---mainlogin.php.html" > mainlogin.php
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_templates---config---mainmanage.php.html" > mainmanage.php
2006-11-15 17:12:15 +00:00
< / a > < br >
2007-11-04 11:19:11 +00:00
< a href = "../configuration/_templates---config---profmanage.php.html" > profmanage.php
2006-11-15 17:12:15 +00:00
< / a > < br >
< / div > < br / >
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< b > Classes:< / b > < br / >
< div class = "package" >
< a href = "../configuration/LAMCfgMain.html" > LAMCfgMain< / a > < br / >
< a href = "../configuration/LAMConfig.html" > LAMConfig< / a > < br / >
< / div >
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< li > < a href = "../configuration/LAMConfig.html#var$scriptRights" > $scriptRights< / a > < / li >
2006-11-15 17:12:15 +00:00
< 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$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 >
2007-11-04 11:19:11 +00:00
< li > < a href = "../configuration/LAMConfig.html#methodget_scriptRights" > get_scriptRights< / a > < / li >
< li > < a href = "../configuration/LAMConfig.html#methodget_scriptServers" > get_scriptServers< / a > < / li >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< li > < a href = "../configuration/LAMConfig.html#methodisWritable" > isWritable< / a > < / li >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< li > < a href = "../configuration/LAMConfig.html#methodset_scriptRights" > set_scriptRights< / a > < / li >
< li > < a href = "../configuration/LAMConfig.html#methodset_scriptServers" > set_scriptServers< / a > < / li >
2006-11-15 17:12:15 +00:00
< 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" >
2007-11-04 11:19:11 +00:00
[line 164]< br / >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 215]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 170]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 212]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 182]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 218]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 179]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 185]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 173]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 196]< / p >
2006-11-15 17:12:15 +00:00
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 / >
2007-11-04 11:19:11 +00:00
< a name = "var$scriptRights" > < / a >
2006-11-15 17:12:15 +00:00
< p > < / p >
2007-11-04 11:19:11 +00:00
< h4 > $scriptRights = < span class = "value" > < / span > < / h4 >
< p > [line 201]< / p >
The rights for the home directory< br / > < br / >
2006-11-15 17:12:15 +00:00
< 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 / >
2007-11-04 11:19:11 +00:00
< a name = "var$scriptServer" > < / a >
2006-11-15 17:12:15 +00:00
< p > < / p >
2007-11-04 11:19:11 +00:00
< h4 > $scriptServer = < span class = "value" > < / span > < / h4 >
< p > [line 209]< / p >
Servers 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 / >
2006-11-15 17:12:15 +00:00
< 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 / >
2007-11-04 11:19:11 +00:00
< a name = "var$ServerURL" > < / a >
2006-11-15 17:12:15 +00:00
< p > < / p >
2007-11-04 11:19:11 +00:00
< h4 > $ServerURL = < span class = "value" > < / span > < / h4 >
< p > [line 167]< / p >
Server address (e.g. ldap://127.0.0.1:389)< br / > < br / >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< p > [line 176]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< p > [line 188]< / p >
2006-11-15 17:12:15 +00:00
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 >
2007-11-04 11:19:11 +00:00
< h3 > constructor LAMConfig < span class = "smalllinenumber" > [line 231]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< h3 > method get_AccountModules < span class = "smalllinenumber" > [line 744]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method get_ActiveTypes < span class = "smalllinenumber" > [line 800]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_Admins" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_Admins < span class = "smalllinenumber" > [line 441]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_Adminstring" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_Adminstring < span class = "smalllinenumber" > [line 450]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_cacheTimeout" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_cacheTimeout < span class = "smalllinenumber" > [line 710]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_cacheTimeoutSec" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_cacheTimeoutSec < span class = "smalllinenumber" > [line 720]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_defaultLanguage" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_defaultLanguage < span class = "smalllinenumber" > [line 579]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_listAttributes" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_listAttributes < span class = "smalllinenumber" > [line 532]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method get_MaxListEntries < span class = "smalllinenumber" > [line 558]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_moduleSettings" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_moduleSettings < span class = "smalllinenumber" > [line 791]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_Passwd" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_Passwd < span class = "smalllinenumber" > [line 474]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_scriptPath" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_scriptPath < span class = "smalllinenumber" > [line 600]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
2007-11-04 11:19:11 +00:00
< a name = "methodget_scriptRights" > < / a >
< h3 > method get_scriptRights < span class = "smalllinenumber" > [line 683]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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" >
2007-11-04 11:19:11 +00:00
< code > string get_scriptRights(
2006-11-15 17:12:15 +00:00
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
2007-11-04 11:19:11 +00:00
Returns the chmod value for new home directories.< br / > < br / > < br / > < br / >
2006-11-15 17:12:15 +00:00
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
2007-11-04 11:19:11 +00:00
< td > < b > return:< / b > < / td > < td > rights< / td >
< / tr >
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
2006-11-15 17:12:15 +00:00
< / tr >
< / table >
< / div >
< br / > < br / >
2007-11-04 11:19:11 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_scriptServers" > < / a >
< h3 > method get_scriptServers < span class = "smalllinenumber" > [line 622]< / 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 / >
2006-11-15 17:12:15 +00:00
2007-11-04 11:19:11 +00:00
2006-11-15 17:12:15 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_ServerURL" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_ServerURL < span class = "smalllinenumber" > [line 420]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodget_Suffix" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method get_Suffix < span class = "smalllinenumber" > [line 496]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method get_typeSettings < span class = "smalllinenumber" > [line 831]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
2007-11-04 11:19:11 +00:00
< a name = "methodisWritable" > < / a >
< h3 > method isWritable < span class = "smalllinenumber" > [line 400]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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" >
2007-11-04 11:19:11 +00:00
< code > boolean isWritable(
2006-11-15 17:12:15 +00:00
)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
2007-11-04 11:19:11 +00:00
Returns if the file can be written on the filesystem.< br / > < br / > < br / > < br / >
2006-11-15 17:12:15 +00:00
< h4 > Tags:< / h4 >
< div class = "tags" >
< table border = "0" cellspacing = "0" cellpadding = "0" >
< tr >
2007-11-04 11:19:11 +00:00
< td > < b > return:< / b > < / td > < td > true if file is writable< / td >
< / tr >
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
2006-11-15 17:12:15 +00:00
< / tr >
< / table >
< / div >
< br / > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodsave" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method save < span class = "smalllinenumber" > [line 304]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 / >
2007-11-04 11:19:11 +00:00
< 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 / >
2006-11-15 17:12:15 +00:00
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodset_AccountModules" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method set_AccountModules < span class = "smalllinenumber" > [line 760]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_ActiveTypes < span class = "smalllinenumber" > [line 810]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 / >
2007-11-04 11:19:11 +00:00
< 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 / >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_Adminstring < span class = "smalllinenumber" > [line 460]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_cacheTimeout < span class = "smalllinenumber" > [line 730]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_defaultLanguage < span class = "smalllinenumber" > [line 589]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_listAttributes < span class = "smalllinenumber" > [line 543]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_MaxListEntries < span class = "smalllinenumber" > [line 568]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_moduleSettings < span class = "smalllinenumber" > [line 780]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_Passwd < span class = "smalllinenumber" > [line 484]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_scriptPath < span class = "smalllinenumber" > [line 610]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 / >
2007-11-04 11:19:11 +00:00
< a name = "methodset_scriptRights" > < / a >
< h3 > method set_scriptRights < span class = "smalllinenumber" > [line 694]< / 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 632]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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" >
2007-11-04 11:19:11 +00:00
< code > boolean set_scriptServers(
2006-11-15 17:12:15 +00:00
string
$value)< / code >
< / td > < / tr > < / table >
< / td > < / tr > < / table > < br / >
2007-11-04 11:19:11 +00:00
Sets the servers of the external script< br / > < br / > < br / > < br / >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< td > new script servers< / td >
2006-11-15 17:12:15 +00:00
< / tr >
< / table >
< / div > < br / >
< div class = "top" > [ < a href = "#top" > Top< / a > ]< / div >
< / div >
< hr / >
< a name = "methodset_ServerURL" > < / a >
2007-11-04 11:19:11 +00:00
< h3 > method set_ServerURL < span class = "smalllinenumber" > [line 430]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_Suffix < span class = "smalllinenumber" > [line 512]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 >
2007-11-04 11:19:11 +00:00
< h3 > method set_typeSettings < span class = "smalllinenumber" > [line 820]< / span > < / h3 >
2006-11-15 17:12:15 +00:00
< 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 >
2007-11-04 11:19:11 +00:00
< tr >
< td > < b > access:< / b > < / td > < td > public< / td >
< / tr >
2006-11-15 17:12:15 +00:00
< / 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 / >
2007-11-04 11:19:11 +00:00
Documentation generated on Sun, 04 Nov 2007 12:10:41 +0100 by < a href = "http://www.phpdoc.org" > phpDocumentor 1.4.0< / a >
2006-11-15 17:12:15 +00:00
< / div >
< / td > < / tr > < / table >
< / td >
< / tr >
< / table >
< / body >
< / html >
