Config

About 3 min

Config

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

supportedExtensions

private array $supportedExtensions = array (
  0 => 'json',
  1 => 'ini',
  2 => 'php',
)

overridePaths

private array $overridePaths

instances

private array $instances

env

private string $env

basePath

private string $basePath

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

public __construct(?string $sourceFile, ?string $env, ?array $defaults): 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

setEnvironment

Set the environment for the configuration.

public setEnvironment(string $env): void

Parameters

Parameter	Type	Description
`$env`	`string`	The environment to set

getEnvironment

Get the config environment that was loaded.

public getEnvironment(): string

setBasePath

Set the base path for the configuration.

public setBasePath(string $path): void

Parameters

Parameter	Type	Description
`$path`	`string`

getBasePath

Get the base path for the configuration.

public getBasePath(): string

setOverridePaths

Set the source file for the configuration.

public setOverridePaths(array $paths): void

Parameters

Parameter	Type	Description
`$paths`	`array`	The paths to search for the configuration file overrides

loadFromFile

Loads a configuration file and returns the configuration options.

public loadFromFile(string $source, ?array $defaults): bool

Parameters

Parameter	Type	Description
`$source`	`string`	the name of the configuration file to load
`$defaults`	`array`	(optional) The default configuration options

loadFromArray

Loads the configuration options from an array.

public loadFromArray(array $options, ?array $defaults): bool

Parameters

Parameter	Type	Description
`$options`	`array`	The configuration options to load
`$defaults`	`array`	(optional) The default configuration options

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

get

public get(string $key): mixed

Parameters

Parameter	Type	Description
`$key`	`string`

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

count

public count(): int

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 $globalOptions, ?string $env): void

Parameters

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

Generated by Hazaar API Doc Generator on Wed, 25 Jun 2025 06:07:09 +0000