PHP Class FOF30\Configuration\Configuration

Since: 2.1
Show file Open project: akeeba/fof

Public Properties

Property Type Description
$configurations array Cache of FOF components' configuration variables

Protected Properties

Property Type Description
$container FOF30\Container\Container The component's container

Public Methods

Method Description
__construct ( Container $c )
get ( string $variable, mixed $default = null ) : mixed Returns the value of a variable. Variables use a dot notation, e.g.

Protected Methods

Method Description
getDomains ( ) : array Gets a list of the available configuration domain adapters
parseComponent ( ) : void Parses the configuration of the specified component
parseComponentArea ( string $area, boolean $userConfig = false ) : array Parses the configuration options of a specific component area

Method Details

__construct() public method

public __construct ( Container $c )
$c FOF30\Container\Container

get() public method

view.config.whatever where the first part is the domain, the rest of the parts specify the path to the variable.
public get ( string $variable, mixed $default = null ) : mixed
$variable string The variable name
$default mixed The default value, or null if not specified
return mixed The value of the variable

getDomains() protected method

Gets a list of the available configuration domain adapters
protected getDomains ( ) : array
return array A list of the available domains

parseComponent() protected method

Parses the configuration of the specified component
protected parseComponent ( ) : void
return void

parseComponentArea() protected method

Parses the configuration options of a specific component area
protected parseComponentArea ( string $area, boolean $userConfig = false ) : array
$area string Which area to parse (frontend, backend, cli)
$userConfig boolean When true the user configuration (fof.user.xml) file will be read
return array A hash array with the configuration data

Property Details

$configurations public static property

Cache of FOF components' configuration variables
public static array $configurations
return array

$container protected property

The component's container
protected Container,FOF30\Container $container
return FOF30\Container\Container