PHP Class CampConfig

Afficher le fichier Open project: sourcefabric/newscoop Class Usage Examples

Méthodes publiques

Méthode	Description
TranslateSettingName ( $p_varName ) : mixed	Translates the given setting variable name into the form namespace and var name.
getAllSettings ( ) : array	Gets all the configuration settings
getSetting ( $p_varName ) : mixed	Gets a setting var value from configuration.
singleton ( string $p_configFile = null ) : object	Builds an instance object of this class only if there is no one.

Private Methods

Méthode	Description
__construct ( string $p_configFile = null )	Class constructor

Method Details

TranslateSettingName() public static méthode

Translates the given setting variable name into the form namespace and var name.

public static TranslateSettingName ( $p_varName ) : mixed
Résultat	mixed	null If the given value is not appropriate settingVar An array containing the namespace and variable actual name

getAllSettings() public méthode

Gets all the configuration settings

public getAllSettings ( ) : array
Résultat	array	m_config The array of settings

getSetting() public méthode

Gets a setting var value from configuration.

public getSetting ( $p_varName ) : mixed
$p_varName		The name of the setting variable
Résultat	mixed	null Var name passed is no valid mixed The value of the setting variable

singleton() public static méthode

Builds an instance object of this class only if there is no one.

public static singleton ( string $p_configFile = null ) : object
$p_configFile	string	The full path to the configuration file
Résultat	object	$m_instance The CampConfig instance