Class JsonConfig

{
    "debug": false,
    "App": {
        "namespace": "MyApp"
    },
    "Security": {
        "salt": "its-secret"
    }
}

__construct()source 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()source 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

boolean
Success

Implementation of

Cake\Core\Configure\ConfigEngineInterface::dump()

read()source 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

array
Parsed configuration values.

Throws

Cake\Core\Exception\Exception

When 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

Cake\Core\Configure\ConfigEngineInterface::read()

_getFilePath()source 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

string
Full file path

Throws

Cake\Core\Exception\Exception

When files don't exist or when files contain '..' as this could lead to abusive reads.

'.json'