ConfigEngineInterface
in
An interface for creating objects compatible with Configure::load()
Table of Contents
Methods
- dump() : bool
- Dumps the configure data into the storage key/file of the given `$key`.
- read() : array<string|int, mixed>
- Read a configuration file/storage key
Methods
dump()
Dumps the configure data into the storage key/file of the given `$key`.
public
dump(string $key, array<string|int, mixed> $data) : bool
Parameters
- $key : string
-
The identifier to write to.
- $data : array<string|int, mixed>
-
The data to dump.
Return values
bool —True on success or false on failure.
read()
Read a configuration file/storage key
public
read(string $key) : array<string|int, mixed>
This method is used for reading configuration information from sources. These sources can either be static resources like files, or dynamic ones like a database, or other datasource.
Parameters
- $key : string
-
Key to read.
Return values
array<string|int, mixed> —An array of data to merge into the runtime configuration