templates/3rdParty/pla/lib/config_default.php
Properties
author
package
todo
Description Configuration processing and defaults.
Constants
REQUIRED_PHP_VERSION
= '5.0.0'
The minimum version of PHP required to run phpLDAPadmin.
Classes
Config
Properties
Extends
Implements
package
subpackage
Abstract No
Final No
Description
The config class contains all our configuration settings for a session. An instance of this class should be stored in $_SESSION to maintain state, and to avoid
rebuilding/rereading it at the state of each page output.
Methods
CheckCustom ,
__construct ,
configDefinition ,
getCommandList ,
getConfigArray ,
getFriendlyAttrs ,
getFriendlyHTML ,
getFriendlyName ,
getServer ,
getServerList ,
getValue ,
haveFriendlyName ,
isCommandAvailable ,
setServers ,
untested ,
CheckCustom(
)
:
n/a
Description
Function to check and warn about any unusual defined variables. Return value
__construct(
)
:
n/a
Return value
configDefinition(
$key,
$index,
$config,
)
:
n/a
Arguments
Name
Type
Description
Default
$key
n/a
$index
n/a
$config
n/a
Return value
getCommandList(
)
:
n/a
Description
Get a list of available commands. Return value
getConfigArray(
$usecache
= true,
)
:
n/a
Description
Access the configuration, taking into account the defaults and the customisations Arguments
Name
Type
Description
Default
$usecache
n/a
true
Return value
getFriendlyAttrs(
)
:
n/a
Description
Return the friendly attributes names Return value
getFriendlyHTML(
$attr,
)
:
string
Description
This function will return the html for a friendly name attribute. Arguments
Name
Type
Description
Default
$attr
n/a
Return value
Type
Description
string
html for the friendly name.
getFriendlyName(
$attr,
)
:
string
Description
This function will return the friendly name of an attribute, if it exists. If the friendly name doesnt exist, the attribute name will be returned. Arguments
Name
Type
Description
Default
$attr
n/a
Return value
Type
Description
string
friendly name|attribute
getServer(
$index
= null,
)
:
n/a
Arguments
Name
Type
Description
Default
$index
n/a
null
Return value
getServerList(
boolean
$visible
= true,
)
:
n/a
Description
Return a list of our servers Arguments
Name
Type
Description
Default
$visible
boolean
Only return visible servers
true
Return value
getValue(
$key,
$index,
$fatal
= true,
)
:
n/a
Description
Get a configuration value. Arguments
Name
Type
Description
Default
$key
n/a
$index
n/a
$fatal
n/a
true
Return value
haveFriendlyName(
$attr,
)
:
boolean
Description
This function will return true if a friendly name exists for an attribute. If the friendly name doesnt exist, it will return false. Arguments
Name
Type
Description
Default
$attr
n/a
Return value
Type
Description
boolean
true|false
isCommandAvailable(
$index
= 'cmd',
)
:
n/a
Description
Simple ACL to see if commands can be run Arguments
Name
Type
Description
Default
$index
n/a
'cmd'
Return value
setServers(
$servers,
)
:
n/a
Arguments
Name
Type
Description
Default
$servers
n/a
Return value
untested(
)
:
n/a
Description
Return the untested config items Return value