Class PhpConfig

PHP engine allows Configure to load configuration values from files containing simple PHP arrays.

Files compatible with PhpConfig should return an array that contains all of the configuration data contained in the file.

An example configuration file would look like::

<?php
return [
    'debug' => 0,
    'Security' => [
        'salt' => 'its-secret'
    ],
    'App' => [
        'namespace' => 'App'
    ]
];

Cake\Core\Configure\Engine\PhpConfig implements Cake\Core\Configure\ConfigEngineInterface uses Cake\Core\Configure\FileConfigTrait

Namespace: Cake\Core\Configure\Engine
See: Cake\Core\Configure::load() for how to load custom configuration files.
Location: Core/Configure/Engine/PhpConfig.php

Properties summary

$_extension protected

string
File extension.

Inherited Properties

_path

Method Summary

__construct() public
Constructor for PHP Config file reading.
dump() public

Converts the provided $data into a string of PHP code that can be used saved into a file and loaded later.
read() public
Read a config file and return its contents.

Method Detail

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

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

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

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

Methods used from Cake\Core\Configure\FileConfigTrait

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

Properties detail

$_extensionsource

protected string

File extension.

'.php'

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Core.Configure.Engine.PhpConfig.html