configuration
[ class tree: configuration ] [ index: configuration ] [ all elements ]

Class: LAMConfig

Source Location: /lib/config.inc

Class Overview


This class manages .conf files.


Variables

Methods



Class Details

[line 164]
This class manages .conf files.



[ Top ]


Class Variables

$activeTypes =  "user,group,host,smbDomain"

[line 215]

Active account types


Type:   mixed


[ Top ]

$Admins =

[line 170]

Array of string: users with admin rights


Type:   mixed


[ Top ]

$cachetimeout =

[line 212]

LDAP cache timeout


Type:   mixed


[ Top ]

$defaultLanguage =

[line 182]

Default language


Type:   mixed


[ Top ]

$file =

[line 218]

Name of configuration file


Type:   mixed


[ Top ]

$maxlistentries =

[line 179]

Maximum number of rows shown in user/group/host lists


Type:   mixed


[ Top ]

$moduleSettings = array()

[line 185]

module settings


Type:   mixed


[ Top ]

$Passwd =

[line 173]

Password to edit preferences


Type:   mixed


[ Top ]

$scriptPath =

[line 196]

Path to external lamdaemon script on server where it is executed

This is used for managing quota and home directories. optional setting, may not be defined



Type:   mixed


[ Top ]

$scriptRights =

[line 201]

The rights for the home directory


Type:   mixed


[ Top ]

$scriptServer =

[line 209]

Servers where lamdaemon script is executed

This is used for managing quota and home directories. optional setting, may not be defined



Type:   mixed


[ Top ]

$ServerURL =

[line 167]

Server address (e.g. ldap://127.0.0.1:389)


Type:   mixed


[ Top ]

$treesuffix =

[line 176]

LDAP suffix for tree view


Type:   mixed


[ Top ]

$typeSettings = array()

[line 188]

type settings


Type:   mixed


[ Top ]



Class Methods


constructor LAMConfig [line 231]

LAMConfig LAMConfig( [integer $file = 0])

Loads preferences from config file



Parameters:

integer   $file   Index number in config file array

[ Top ]

method get_AccountModules [line 744]

array get_AccountModules( string $scope)

Returns an array of all selected account modules



Tags:

return:  user modules
access:  public


Parameters:

string   $scope   account type

[ Top ]

method get_ActiveTypes [line 800]

array get_ActiveTypes( )

Returns a list of active account types.



Tags:

return:  list of types
access:  public


[ Top ]

method get_Admins [line 441]

array get_Admins( )

Returns an array of string with all admin names



Tags:

return:  the admin names
access:  public


[ Top ]

method get_Adminstring [line 450]

string get_Adminstring( )

Returns all admin users seperated by semicolons



Tags:

return:  the admin string
access:  public


[ Top ]

method get_cacheTimeout [line 710]

integer get_cacheTimeout( )

Returns the LDAP cache timeout in minutes



Tags:

return:  cache time
access:  public


[ Top ]

method get_cacheTimeoutSec [line 720]

integer get_cacheTimeoutSec( )

Returns the LDAP cache timeout in seconds



Tags:

return:  cache time
access:  public


[ Top ]

method get_defaultLanguage [line 579]

string get_defaultLanguage( )

Returns the default language string



Tags:

return:  default language
access:  public


[ Top ]

method get_listAttributes [line 532]

string get_listAttributes( string $scope)

Returns the list of attributes to show in user list



Tags:

return:  the attribute list
access:  public


Parameters:

string   $scope   account type

[ Top ]

method get_MaxListEntries [line 558]

integer get_MaxListEntries( )

Returns the maximum number of rows in user/group/host lists



Tags:

return:  maximum number
access:  public


[ Top ]

method get_moduleSettings [line 791]

array get_moduleSettings( )

Returns a list of saved module settings



Tags:

return:  list of settings: array(name => value)
access:  public


[ Top ]

method get_Passwd [line 474]

string get_Passwd( )

Returns the password to access the preferences wizard



Tags:

return:  the password
access:  public


[ Top ]

method get_scriptPath [line 600]

string get_scriptPath( )

Returns the path to the external script



Tags:

return:  script path
access:  public


[ Top ]

method get_scriptRights [line 683]

string get_scriptRights( )

Returns the chmod value for new home directories.



Tags:

return:  rights
access:  public


[ Top ]

method get_scriptServers [line 622]

string get_scriptServers( )

Returns the servers of the external script as a Array



Tags:

return:  script servers
access:  public


[ Top ]

method get_ServerURL [line 420]

string get_ServerURL( )

Returns the server address as string



Tags:

return:  server address
access:  public


[ Top ]

method get_Suffix [line 496]

string get_Suffix( string $scope)

Returns the LDAP suffix for the given account type



Tags:

return:  the LDAP suffix
access:  public


Parameters:

string   $scope   account type

[ Top ]

method get_typeSettings [line 831]

array get_typeSettings( )

Returns a list of saved type settings



Tags:

return:  list of settings: array(name => value)
access:  public


[ Top ]

method isWritable [line 400]

boolean isWritable( )

Returns if the file can be written on the filesystem.



Tags:

return:  true if file is writable
access:  public


[ Top ]

method save [line 304]

void save( )

Saves preferences to config file



Tags:

access:  public


[ Top ]

method set_AccountModules [line 760]

boolean set_AccountModules( array $modules, string $scope)

Sets the selected account modules



Tags:

return:  true if $modules has correct format
access:  public


Parameters:

array   $modules   array with module names (not aliases!)
string   $scope   account type

[ Top ]

method set_ActiveTypes [line 810]

void set_ActiveTypes( array $types)

Sets the list of active types.



Tags:

access:  public


Parameters:

array   $types   list of types

[ Top ]

method set_Adminstring [line 460]

boolean set_Adminstring( string $value)

Sets the admin string



Tags:

return:  true if $value has correct format
access:  public


Parameters:

string   $value   new admin string that contains all admin users seperated by semicolons

[ Top ]

method set_cacheTimeout [line 730]

boolean set_cacheTimeout( integer $value)

Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)



Tags:

return:  true if $value has correct format
access:  public


Parameters:

integer   $value   new cache timeout

[ Top ]

method set_defaultLanguage [line 589]

boolean set_defaultLanguage( string $value)

Sets the default language string



Tags:

return:  true if $value has correct format
access:  public


Parameters:

string   $value   new default language

[ Top ]

method set_listAttributes [line 543]

boolean set_listAttributes( string $value, string $scope)

Sets the list of attributes to show in user list



Tags:

return:  true if $value has correct format
access:  public


Parameters:

string   $value   new attribute string
string   $scope   account type

[ Top ]

method set_MaxListEntries [line 568]

boolean set_MaxListEntries( integer $value)

Sets the maximum number of rows in user/group/host lists



Tags:

return:  true if $value has correct format
access:  public


Parameters:

integer   $value   new maximum value

[ Top ]

method set_moduleSettings [line 780]

boolean set_moduleSettings( array $settings)

Sets the settings for the account modules.



Tags:

return:  true if $settings has correct format
access:  public


Parameters:

array   $settings   list of module setting array(name => value)

[ Top ]

method set_Passwd [line 484]

boolean set_Passwd( string $value)

Sets the preferences wizard password



Tags:

return:  true if $value has correct format
access:  public


Parameters:

string   $value   new password

[ Top ]

method set_scriptPath [line 610]

boolean set_scriptPath( string $value)

Sets the path to the external script



Tags:

return:  true if $value has correct format
access:  public


Parameters:

string   $value   new script path

[ Top ]

method set_scriptRights [line 694]

boolean set_scriptRights( string $chmod)

Sets the rights for the home directory.



Tags:

return:  true if values has correct format
access:  public


Parameters:

string   $chmod   the rights

[ Top ]

method set_scriptServers [line 632]

boolean set_scriptServers( string $value)

Sets the servers of the external script



Tags:

return:  true if $value has correct format
access:  public


Parameters:

string   $value   new script servers

[ Top ]

method set_ServerURL [line 430]

boolean set_ServerURL( string $value)

Sets the server address



Tags:

return:  true if $value has correct format
access:  public


Parameters:

string   $value   new server address

[ Top ]

method set_Suffix [line 512]

boolean set_Suffix( string $scope, string $value)

Sets the LDAP suffix where accounts are saved



Tags:

return:  true if $value has correct format
access:  public


Parameters:

string   $scope   account type
string   $value   new LDAP suffix

[ Top ]

method set_typeSettings [line 820]

boolean set_typeSettings( array $settings)

Sets the settings for the account types.



Tags:

return:  true if $settings has correct format
access:  public


Parameters:

array   $settings   list of type setting array(name => value)

[ Top ]


Documentation generated on Sun, 04 Nov 2007 12:10:41 +0100 by phpDocumentor 1.4.0