Class RecursiveDirectoryConfig.
Description
Extends DirectoryConfig to support recursive loading of configuration files from a root directory. This class SHALL match both top-level and nested PHP files using a recursive glob pattern.
Constants
Properties
Methods
Constructs a DirectoryConfig instance.
Implementing class MUST define the __invoke() method to return a ConfigInterface instance.
Retrieves a configuration value by key.
Retrieves an iterator for traversing the configuration data.
Checks for existence of a configuration key.
Removes a configuration key.
Sets configuration data.
Exports the entire configuration to an array.
Retrieves or initializes the configuration instance.
private
ConfigInterface|null
$config
=
null
Description
holds the loaded configuration instance
Constructs a DirectoryConfig instance.
public
__construct(
string
$directory[,
string|null
$cachedConfigFile = null]) : mixed
Description
This constructor SHALL validate the specified directory, and initialize the Laminas config aggregator with a PHP file provider using the defined pattern. If a cache file is provided, it SHALL be used to store the aggregated configuration.
Parameters
$directory
:
string
Description
the directory path from which to load configuration files
$cachedConfigFile
:
string|null
=
null
Description
optional path to a cache file for the aggregated configuration
Implementing class MUST define the __invoke() method to return a ConfigInterface instance.
public
abstract
__invoke() : ConfigInterface
Return values
Description
the actual configuration instance
Retrieves a configuration value by key.
public
get(
string
$key[,
mixed|null
$default = null]) : mixed
Parameters
$key
:
string
Description
the configuration key to retrieve
$default
:
mixed|null
=
null
Description
the default value if the key is not found
Return values
Description
the value of the configuration key or the default
Retrieves an iterator for traversing the configuration data.
public
getIterator() : Traversable
Return values
Description
an iterator over the configuration
Checks for existence of a configuration key.
public
has(
string
$key) : bool
Parameters
$key
:
string
Description
the configuration key to check
Return values
Description
TRUE if the key exists, FALSE otherwise
Removes a configuration key.
public
remove(
string
$key) : void
Parameters
$key
:
string
Description
the configuration key to remove
Sets configuration data.
public
set(
array<string|int, mixed>|ConfigInterface|string
$key[,
mixed|null
$value = null]) : void
Parameters
Description
the key or set of keys/values to set
$value
:
mixed|null
=
null
Description
the value to set if a single key is provided
Exports the entire configuration to an array.
public
toArray() : array<string|int, mixed>
Return values
Description
the configuration as an associative array
Retrieves or initializes the configuration instance.
private
getConfig() : ConfigInterface
Return values
Description
the lazily-loaded configuration object