Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitBackendIniConfigurationBase

Packages:

Interfaces:

Classes:

Core::IniBackend::arbitBackendIniConfigurationBase

[ Index ] [ Core classes ] [ Core elements ] [ All elements ] [ Errors ]

Class arbitBackendIniConfigurationBase

Base class for configuration wrappers

Base class for configuration wrappers

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

Descendants

Child Class Description
arbitBackendIniProjectConfiguration arbit project configuration
arbitBackendIniModuleConfiguration arbit module configuration
arbitBackendIniMainConfiguration arbit main configuration

Member Variables

protected ezcConfigurationManager $config
Configuration manager instance

Configuration manager instance
protected array $defaultValues = array()
Array with default values for all required configuration directives. array has the followin structure:

Array with default values for all required configuration directives. The array has the followin structure:

  1.   array(
  2.       'group' => array(
  3.           'key' => $value,
  4.           ...
  5.       ),
  6.       ...
  7.   )
protected string $iniFile = null
Used ini file.

Used ini file. This should be set in the extending class.
protected array $shortcuts = array()
Shortcuts for configuration value access.

Shortcuts for configuration value access. These shortcuts may be used for property access to the configuration values. The shortcut array has the following structure:

  1.   array(
  2.       'shortcut' => array( 'group', 'value' ),
  3.       ...
  4.   )
protected array $valueCache = array()
All values, which were fetched once are stored in the value cache and returned from there in any later request to this value.

All values, which were fetched once are stored in the value cache and returned from there in any later request to this value.

Method Summary

public void __construct( $config )
Construct from ezc configuration manager
public void get( $group , $value )
Get a configuration value
public void getAll( )
Returns an array with all configuration options and shortcuts
public void __set( $property , $value )
Property setting stub, always throwing an exception.

Methods

__construct

void __construct( $config )

Construct from ezc configuration manager

Construct from ezc configuration manager

Parameters:
Name Type Description
$config ezcConfigurationManager
Redefined in descendants as:
Method Description
arbitBackendIniProjectConfiguration::__construct() Construct from ezc configuration manager 
arbitBackendIniModuleConfiguration::__construct() Construct from ezc configuration manager 
arbitBackendIniMainConfiguration::__construct() Construct from ezc configuration manager 

get

void get( mixed $group , mixed $value )

Get a configuration value

Get a configuration value

Parameters:
Name Type Description
$group mixed
$value mixed

getAll

void getAll( )

Returns an array with all configuration options and shortcuts

Returns an array with all configuration options and shortcuts

__set

void __set( string $property , mixed $value )

Property setting stub, always throwing an exception.

Property setting stub, always throwing an exception.

Parameters:
Name Type Description
$property string
$value mixed
Documentation generated on Mon, 05 Apr 2010 14:01:36 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3