Class PhpConfig

__constructsource public

__construct( string|null $path null )

Constructor for PHP Config file reading.

Parameters

string|null $path optional null

The path to read config files from. Defaults to CONFIG.

dumpsource public

dump( string $key , array $data )

Converts the provided $data into a string of PHP code 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()

readsource 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().

Setting a $config variable is deprecated. Use return instead.

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 they don't contain $config. Or when files contain '..' as this could lead to abusive reads.

Implementation of

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

_getFilePathsource 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.

'.php'

''