Configuration

A bootstrapper for reading in module and configuration info.

class Configuration

This class expects a Traversable full of class names in the system.modules configuration setting. Each class name must extend Labrys\Module or an UnexpectedValueException will be thrown.

Copyright
2015-2016 Appertly
Since
0.5.0
License
Apache-2.0

Instance Properties

Protected
NameTypeSummary
$configProperties

The config container

$modulesImmVector<Module>

Instantiated modules

Constructors / Destructors

Public
ReturnsSignature and Description
void
__construct(ConstMap<string,mixed> $config)

Creates a new Configuration.

Instance Methods

Public
ReturnsSignature and Description
Properties
getConfigContainer()

Gets the configuration settings container.

ImmVector<Module>
getModules()

Gets the loaded modules.

Property Details

$config

protected Properties $config

The config container

$modules

protected ImmVector<Module> $modules

Instantiated modules

Method Details

__construct

public function __construct(ConstMap<string,mixed> $config)

Creates a new Configuration.

This constructor expects a Traversable full of class names in the system.modules configuration setting. Each class name must extend Labrys\Module or an UnexpectedValueException will be thrown.

Parameters
NameTypeDescription
$configConstMap<string,mixed>

The system configuration

Throws
TypeConditions
UnexpectedValueException

if a module class doesn't extend Labrys\Module

getConfigContainer

public function getConfigContainer()

Gets the configuration settings container.

Returns
TypeDescription
Properties

The config container

getModules

public function getModules()

Gets the loaded modules.

Returns
TypeDescription
ImmVector<Module>

The loaded modules