Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitBackendIniConfigurationManager

Core::IniBackend::arbitBackendIniConfigurationManager

Class arbitBackendIniConfigurationManager

Basic ini configuration manager.

Basic ini configuration manager. Implements static access to all relevant configuration parts and ensures lazy loading to spare the maximum amount of ini parsing effort. It does not implement caching for parsed ini files, but this might be added in this class later.

Author(s):
Version:   $Revision: 1673 $
License:   GPL

Member Variables

protected static ezcConfigurationManager $confManager
Configuration manager

Configuration manager

protected static arbitBackendIniMainConfiguration $main
Main configuration file

Main configuration file

protected static array $modules
Conatins the configuration for all modules per project. structure looks like:

Conatins the configuration for all modules per project. The array structure looks like:

  1.   array(
  2.       'projectname' => array(
  3.           'modulename' => arbitBackendIniModuleConfiguration,
  4.           ...
  5.       ),
  6.       ...
  7.   )

protected static array(arbitBackendIniProjectConfiguration) $projects
Configurations for all registered projects

Configurations for all registered projects

Method Summary

protected static void createConfigurationInstance( )
Ensure existance of ezcConfigurationManager existance Ensure a valid instance of the ezcConfigurationManager, which is used as a backend to initialize the ocnfiguration structures.
public static arbitBackendIniMainConfiguration getMainConfiguration( )
Get arbit main configuration Get the main configuration of the current arbit instance.
public static arbitBackendIniModuleConfiguration getModuleConfiguration( $project , $module , [ $class = 'arbitBackendIniModuleConfiguration'] )
Get configuration of a projects module Receive the configuration for a module in the given project.
public static arbitBackendIniProjectConfiguration getProjectConfiguration( $project )
Get configuration of a project Receive the configuration for the given project.

Methods

createConfigurationInstance

static void createConfigurationInstance( )

Ensure existance of ezcConfigurationManager existance Ensure a valid instance of the ezcConfigurationManager, which is used as a backend to initialize the ocnfiguration structures.

Ensure existance of ezcConfigurationManager existance Ensure a valid instance of the ezcConfigurationManager, which is used as a backend to initialize the ocnfiguration structures.

getMainConfiguration

static arbitBackendIniMainConfiguration getMainConfiguration( )

Get arbit main configuration Get the main configuration of the current arbit instance.

Get arbit main configuration Get the main configuration of the current arbit instance.

getModuleConfiguration

static arbitBackendIniModuleConfiguration getModuleConfiguration( string $project , string $module , [string $class = 'arbitBackendIniModuleConfiguration'] )

Get configuration of a projects module Receive the configuration for a module in the given project.

Get configuration of a projects module Receive the configuration for a module in the given project. Optionally you may specify a class with default values for the settings, like available for the project and main configuration. By default the arbitBackendIniModuleConfiguration class, without any default values, will be used.

Parameters:
Name Type Description
$project string
$module string
$class string

getProjectConfiguration

static arbitBackendIniProjectConfiguration getProjectConfiguration( string $project )

Get configuration of a project Receive the configuration for the given project.

Get configuration of a project Receive the configuration for the given project.

Parameters:
Name Type Description
$project string
Documentation generated on Mon, 05 Apr 2010 14:02:03 +0200 by phpDocumentor 1.4.3