Docs For Class Config

Class: Config

Class Details

[line 27]
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.

Tags:

author:	The phpLDAPadmin development team
author:	Deon George

Class Methods

constructor __construct [line 44]

Config __construct(
)

[ Top ]

method CheckCustom [line 511]

void CheckCustom(
)

Function to check and warn about any unusual defined variables.

[ Top ]

method getFriendlyAttrs [line 583]

void getFriendlyAttrs(

$friendly_attrs)

Reads the friendly_attrs array as defined in config.php and lower-cases all the keys. Will return an empty array if the friendly_attrs array is not defined in config.php. This is simply used so we can more easily lookup user-friendly attributes configured by the admin.

Parameters:

$friendly_attrs

[ Top ]

method getFriendlyHTML [line 628]

string getFriendlyHTML(
attribute
$attr)

This function will return the <ancronym> html for a friendly name attribute.

Tags:

return:

html for the friendly name.

Parameters:

attribute

$attr

[ Top ]

method getFriendlyName [line 603]

string getFriendlyName(
attribute
$attr)

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.

Tags:

return:

friendly name|attribute

Parameters:

attribute

$attr

[ Top ]

method GetValue [line 479]

void GetValue(

$key, 
$index)

Parameters:

	$key
	$index

[ Top ]

method haveFriendlyName [line 617]

boolean haveFriendlyName(
attribute
$attr)

This function will return true if a friendly name exists for an attribute.

If the friendly name doesnt exist, it will return false.

Tags:

return:

true|false

Parameters:

attribute

$attr

[ Top ]

method isCommandAvailable [line 544]

void isCommandAvailable(
)

The parameter number is variable.

For example : isCommandAvailable('search', 'simple_search')

[ Top ]

Documentation generated on Sun, 30 Dec 2007 17:49:24 -0800 by phpDocumentor 1.3.1

Class: Config

Class Overview

Author(s):

Methods

Class Details

Tags:

Class Methods

constructor __construct [line 44]

method CheckCustom [line 511]

method getFriendlyAttrs [line 583]

Parameters:

method getFriendlyHTML [line 628]

Tags:

Parameters:

method getFriendlyName [line 603]

Tags:

Parameters:

method GetValue [line 479]

Parameters:

method haveFriendlyName [line 617]

Tags:

Parameters:

method isCommandAvailable [line 544]