Config

Application Configuration Class.

The config class loads settings from a configuration file and configures the system ready for the application to run. By default the config file used is application.ini and is stored in the config folder of the application path.

Properties

overridePaths

public array $overridePaths

instances

private array $instances

env

private string $env

source

private string $source

sourceFile

public string $sourceFile

global

private array $global

secureKeys

private array $secureKeys

includes

private array $includes

options

The configuration options for the selected environment.

private array $options

Methods

__construct

protected __construct(?string $sourceFile, ?string $env, array $defaults = [], bool $overrideNamespaces = false): void

The application configuration constructor loads the settings from the configuration file specified in the first parameter. It will use the second parameter as the starting point and is intended to allow different operating environments to be configured from a single configuration file.

Parameters

Parameter	Type	Description
$sourceFile	string	The absolute path to the config file
$env	string	The application environment to read settings for. Usually development

                            or `production`. |

| $defaults | array | initial defaut values9 | | $overrideNamespaces | bool | |

__toString

Output the configuration in a human readable format.

public __toString(): string

This method is useful for logging, debugging or for using in application administration interfaces to check the current running configuration.

Example Output

app.name = Example Application
app.version = 0.0.1
app.layout = application
app.theme.name = test
app.defaultController = Index
app.debug = 1
paths.model = models
paths.view = views
paths.controller = controllers
php.date.timezone = Australia/ACT
php.display_startup_errors = 1
php.display_errors = 1
module.require[] = pgsql

getInstance

public getInstance(?string $sourceFile, ?string $env, array $defaults = [], bool $overrideNamespaces = false): Config

Parameters

Parameter	Type	Description
$sourceFile	string
$env	string
$defaults	array
$overrideNamespaces	bool

load

Loads a configuration file and returns the configuration options.

public load(string $source, string $env = 'APPLICATION_ENV', array $defaults = [], bool $overrideNamespaces = false): void

Parameters

Parameter	Type	Description
$source	string	the name of the configuration file to load
$env	string	(optional) The environment to load the configuration for. If null, the default environment will be used.
$defaults	array	(optional) The default configuration options
$overrideNamespaces	bool	(optional) Whether to override namespaces when searching for the file

getEnv

Get the config environment that was loaded.

public getEnv(): string

getEnvConfig

Retrieves the environment configuration array.

public getEnvConfig(?string $env): void

This method returns the configuration array for the specified environment. If no environment is specified, it uses the default environment set in the application.

Parameters

Parameter	Type	Description
$env	string	The environment for which to retrieve the configuration. Defaults to null.

getEnvironments

Get the list of environments defined in the configuration.

public getEnvironments(): void

toString

Converts the configuration object to a string representation.

public toString(): string

toSecureArray

Converts the configuration object to a secure array by removing the secure keys.

public toSecureArray(): void

save

public save(): bool

offsetExists

public offsetExists(mixed $offset): bool

Parameters

Parameter	Type	Description
$offset	mixed

offsetGet

public offsetGet(mixed $offset): mixed

Parameters

Parameter	Type	Description
$offset	mixed

offsetSet

public offsetSet(mixed $offset, mixed $value): void

Parameters

Parameter	Type	Description
$offset	mixed
$value	mixed

offsetUnset

public offsetUnset(mixed $offset): void

Parameters

Parameter	Type	Description
$offset	mixed

toArray

Converts the configuration object to an array.

public toArray(): void

current

public current(): mixed

next

public next(): void

key

public key(): mixed

valid

public valid(): bool

rewind

public rewind(): void

extend

Extends the configuration options with the given configuration array.

public extend(array $config): void

This method merges the given configuration array with the existing configuration options.

Parameters

Parameter	Type	Description
$config	array	the configuration array to extend the existing configuration options

loadSourceFile

Loads the configuration file from the given source.

private loadSourceFile(string $source): void

Parameters

Parameter	Type	Description
$source	string	the path to the configuration file

loadConfigOptions

Loads the configuration options into the provided Map object based on the given options array and environment.

private loadConfigOptions(array $config, array $options, ?string $env): void

Parameters

Parameter	Type	Description
$config	array	the config to store the configuration options
$options	array	the array of configuration options
$env	string	The environment to load the configuration for. If null, the default environment will be used.

---

Generated by Hazaar API Doc Generator