ServiceBuilderLoader
extends AbstractConfigLoader
in package
Service builder config loader
Table of Contents
Properties
- $aliases : array<string|int, mixed>
- $jsonErrors : array<string|int, mixed>
- $loadedFiles : array<string|int, mixed>
Methods
- addAlias() : self
- Add an include alias to the loader
- load() : mixed
- Loads configuration data and returns an array of the loaded result
- removeAlias() : self
- Remove an alias from the loader
- build() : mixed
- Perform the parsing of a config file and create the end result
- loadFile() : array<string|int, mixed>
- Load a configuration file (can load JSON or PHP files that return an array when included)
- mergeData() : array<string|int, mixed>
- Default implementation for merging two arrays of data (uses array_merge_recursive)
- mergeIncludes() : array<string|int, mixed>
- Merges in all include files
Properties
$aliases
protected
array<string|int, mixed>
$aliases
= array()
Array of aliases for actual filenames
$jsonErrors
protected
static array<string|int, mixed>
$jsonErrors
= array(JSON_ERROR_NONE => 'JSON_ERROR_NONE - No errors', JSON_ERROR_DEPTH => 'JSON_ERROR_DEPTH - Maximum stack depth exceeded', JSON_ERROR_STATE_MISMATCH => 'JSON_ERROR_STATE_MISMATCH - Underflow or the modes mismatch', JSON_ERROR_CTRL_CHAR => 'JSON_ERROR_CTRL_CHAR - Unexpected control character found', JSON_ERROR_SYNTAX => 'JSON_ERROR_SYNTAX - Syntax error, malformed JSON', JSON_ERROR_UTF8 => 'JSON_ERROR_UTF8 - Malformed UTF-8 characters, possibly incorrectly encoded')
JSON error code mappings
$loadedFiles
protected
array<string|int, mixed>
$loadedFiles
= array()
Hash of previously loaded filenames
Methods
addAlias()
Add an include alias to the loader
public
addAlias(string $filename, string $alias) : self
Parameters
- $filename : string
-
Filename to alias (e.g. _foo)
- $alias : string
-
Actual file to use (e.g. /path/to/foo.json)
Return values
selfload()
Loads configuration data and returns an array of the loaded result
public
load(mixed $config[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $config : mixed
-
Data to load (filename or array of data)
- $options : array<string|int, mixed> = array()
-
Array of options to use when loading
removeAlias()
Remove an alias from the loader
public
removeAlias(string $alias) : self
Parameters
- $alias : string
-
Alias to remove
Return values
selfbuild()
Perform the parsing of a config file and create the end result
protected
build(mixed $config, array<string|int, mixed> $options) : mixed
Parameters
- $config : mixed
-
Configuration data
- $options : array<string|int, mixed>
-
Options to use when building
loadFile()
Load a configuration file (can load JSON or PHP files that return an array when included)
protected
loadFile(string $filename) : array<string|int, mixed>
Parameters
- $filename : string
-
File to load
Tags
Return values
array<string|int, mixed>mergeData()
Default implementation for merging two arrays of data (uses array_merge_recursive)
protected
mergeData(array<string|int, mixed> $a, array<string|int, mixed> $b) : array<string|int, mixed>
Parameters
- $a : array<string|int, mixed>
-
Original data
- $b : array<string|int, mixed>
-
Data to merge into the original and overwrite existing values
Return values
array<string|int, mixed>mergeIncludes()
Merges in all include files
protected
mergeIncludes(array<string|int, mixed> &$config[, string $basePath = null ]) : array<string|int, mixed>
Parameters
- $config : array<string|int, mixed>
-
Config data that contains includes
- $basePath : string = null
-
Base path to use when a relative path is encountered
Return values
array<string|int, mixed> —Returns the merged and included data