Class JsonConfig
JSON engine allows Configure to load configuration values from files containing JSON strings.
An example JSON file would look like::
{
"debug": false,
"App": {
"namespace": "MyApp"
},
"Security": {
"salt": "its-secret"
}
}
- Cake\Core\Configure\Engine\JsonConfig implements Cake\Core\Configure\ConfigEngineInterface uses Cake\Core\Configure\FileConfigTrait
Properties summary
-
$_extensionprotectedstringFile extension.
Inherited Properties
Method Summary
-
__construct() public
Constructor for JSON Config file reading. -
dump() public
Converts the provided $data into a JSON string that can be used saved into a file and loaded later.
-
read() public
Read a config file and return its contents.
Method Detail
__construct() public ¶
__construct( string|null $path null )
Constructor for JSON Config file reading.
Parameters
- string|null $path optional null
- The path to read config files from. Defaults to CONFIG.
dump() public ¶
dump( string $key , array $data )
Converts the provided $data into a JSON string that can be used saved into a file and loaded later.
Parameters
- string $key
The identifier to write to. If the key has a . it will be treated as a plugin prefix.
- array $data
- Data to dump.
Returns
Success
Implementation of
read() public ¶
read( string $key )
Read a config file and return its contents.
Files with . in the name will be treated as values in plugins. Instead of
reading from the initialized path, plugin keys will be located using Plugin::path().
Parameters
- string $key
The identifier to read from. If the key has a . it will be treated as a plugin prefix.
Returns
Parsed configuration values.
Throws
Cake\Core\Exception\ExceptionWhen files don't exist or when files contain '..' (as this could lead to abusive reads) or when there is an error parsing the JSON string.
Implementation of
Methods used from Cake\Core\Configure\FileConfigTrait
_getFilePath() protected ¶
_getFilePath( string $key , boolean $checkExists false )
Get file path
Parameters
- string $key
The identifier to write to. If the key has a . it will be treated as a plugin prefix.
- boolean $checkExists optional false
- Whether to check if file exists. Defaults to false.
Returns
Full file path
Throws
Cake\Core\Exception\ExceptionWhen files don't exist or when files contain '..' as this could lead to abusive reads.