\Anax\ConfigureConfigure2Trait

Trait implementing reading from config file and config directory and storing options in $this->config.

Summary

Methods
Properties
Constants
configure()
getConfig()
No public properties found
No constants found
No protected methods found
$config
N/A
No private methods found
No private properties found
N/A

Properties

$config

$config : array<mixed,>

Type

array<mixed,> — store the configuration in this array.

Methods

configure()

configure(array|string  $what) : self

Read configuration from file or array, if a file, first check in ANAX_APP_PATH/config and then in ANAX_INSTALL_PATH/config.

Parameters

array|string $what

is an array with key/value config options or a file to be included which returns such an array.

Throws

\Anax\Configure\Exception

when argument if not a file nor an array.

Returns

self —

for chaining.

getConfig()

getConfig(string  $key, string  $default = null) : mixed

Helper function for reading values from the configuration and appy default values where configuration item is missing.

Parameters

string $key

matching a key in the config array.

string $default

value returned when config item is not found.

Returns

mixed —

or null if key does not exists.