: str_replace(): Passing null to parameter #2 ($replace) of type array|string is deprecated in
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @license https://opensource.org/licenses/mit-license.php MIT License
use Cake\Core\Exception\Exception;
use InvalidArgumentException;
* A trait for reading and writing instance config
* Implementing objects are expected to declare a `$_defaultConfig` property.
trait InstanceConfigTrait
* Whether the config property has already been configured with defaults
protected $_configInitialized = false;
* Setting a specific value:
* $this->setConfig('key', $value);
* Setting a nested value:
* $this->setConfig('some.nested.key', $value);
* Updating multiple config settings at the same time:
* $this->setConfig(['one' => 'value', 'another' => 'value']);
* @param string|array $key The key to set, or a complete array of configs.
* @param mixed|null $value The value to set.
* @param bool $merge Whether to recursively merge or overwrite existing config, defaults to true.
* @throws \Cake\Core\Exception\Exception When trying to set a key that is invalid.
public function setConfig($key, $value = null, $merge = true)
if (!$this->_configInitialized) {
$this->_config = $this->_defaultConfig;
$this->_configInitialized = true;
$this->_configWrite($key, $value, $merge);
* Reading the whole config:
* Reading a specific value:
* $this->getConfig('key');
* Reading a nested value:
* $this->getConfig('some.nested.key');
* Reading with default value:
* $this->getConfig('some-key', 'default-value');
* @param string|null $key The key to get or null for the whole config.
* @param mixed|null $default The return value when the key does not exist.
* @return mixed|null Configuration data at the named key or null if the key does not exist.
public function getConfig($key = null, $default = null)
if (!$this->_configInitialized) {
$this->_config = $this->_defaultConfig;
$this->_configInitialized = true;
$return = $this->_configRead($key);
return $return === null ? $default : $return;
* Reading the whole config:
* Reading a specific value:
* Reading a nested value:
* $this->config('some.nested.key');
* Setting a specific value:
* $this->config('key', $value);
* Setting a nested value:
* $this->config('some.nested.key', $value);
* Updating multiple config settings at the same time:
* $this->config(['one' => 'value', 'another' => 'value']);
* @deprecated 3.4.0 use setConfig()/getConfig() instead.
* @param string|array|null $key The key to get/set, or a complete array of configs.
* @param mixed|null $value The value to set.
* @param bool $merge Whether to recursively merge or overwrite existing config, defaults to true.
* @return mixed Config value being read, or the object itself on write operations.
* @throws \Cake\Core\Exception\Exception When trying to set a key that is invalid.
public function config($key = null, $value = null, $merge = true)
get_called_class() . '::config() is deprecated. ' .
'Use setConfig()/getConfig() instead.'
if (is_array($key) || func_num_args() >= 2) {
return $this->setConfig($key, $value, $merge);
return $this->getConfig($key);
* Returns the config for this specific key.
* The config value for this key must exist, it can never be null.
* @param string|null $key The key to get.
* @return mixed Configuration data at the named key
* @throws \InvalidArgumentException
public function getConfigOrFail($key)
throw new InvalidArgumentException('$key must not be null.');
$config = $this->getConfig($key);
throw new InvalidArgumentException(sprintf('Expected configuration `%s` not found.', $key));
* Merge provided config with existing config. Unlike `config()` which does
* a recursive merge for nested keys, this method does a simple merge.
* Setting a specific value:
* $this->configShallow('key', $value);
* Setting a nested value:
* $this->configShallow('some.nested.key', $value);
* Updating multiple config settings at the same time:
* $this->configShallow(['one' => 'value', 'another' => 'value']);
* @param string|array $key The key to set, or a complete array of configs.
* @param mixed|null $value The value to set.
public function configShallow($key, $value = null)
if (!$this->_configInitialized) {
$this->_config = $this->_defaultConfig;
$this->_configInitialized = true;
$this->_configWrite($key, $value, 'shallow');
* @param string|null $key Key to read.
protected function _configRead($key)
if (strpos($key, '.') === false) {
return isset($this->_config[$key]) ? $this->_config[$key] : null;
$return = $this->_config;
foreach (explode('.', $key) as $k) {
if (!is_array($return) || !isset($return[$k])) {
* @param string|array $key Key to write to.
* @param mixed $value Value to write.
* @param bool|string $merge True to merge recursively, 'shallow' for simple merge,
* false to overwrite, defaults to false.
* @throws \Cake\Core\Exception\Exception if attempting to clobber existing config
protected function _configWrite($key, $value, $merge = false)
if (is_string($key) && $value === null) {
$this->_configDelete($key);
$update = is_array($key) ? $key : [$key => $value];
if ($merge === 'shallow') {
$this->_config = array_merge($this->_config, Hash::expand($update));
$this->_config = Hash::merge($this->_config, Hash::expand($update));
foreach ($key as $k => $val) {
$this->_configWrite($k, $val);
if (strpos($key, '.') === false) {
$this->_config[$key] = $value;
$update =& $this->_config;
$stack = explode('.', $key);
if (!is_array($update)) {
throw new Exception(sprintf('Cannot set %s value', $key));
if (!isset($update[$k])) {
* Deletes a single config key.
* @param string $key Key to delete.
* @throws \Cake\Core\Exception\Exception if attempting to clobber existing config
protected function _configDelete($key)
if (strpos($key, '.') === false) {
unset($this->_config[$key]);
$update =& $this->_config;
$stack = explode('.', $key);
foreach ($stack as $i => $k) {
if (!is_array($update)) {
throw new Exception(sprintf('Cannot unset %s value', $key));
if (!isset($update[$k])) {
if ($i === $length - 1) {
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
