Trait InstanceConfigTrait

A trait for reading and writing instance config

Implementing objects are expected to declare a $_defaultConfig property.

Direct Known Users

Cake\Auth\AbstractPasswordHasher, Cake\Auth\BaseAuthenticate, Cake\Network\Socket, Cake\ORM\Behavior, Cake\Routing\DispatcherFilter, Cake\View\Helper, Cake\View\StringTemplate, Cake\Auth\BaseAuthorize, Cake\Auth\Storage\SessionStorage, Cake\Cache\CacheEngine, Cake\Console\Helper, Cake\Controller\Component, Cake\Log\Engine\BaseLog, Cake\Mailer\AbstractTransport, Cake\Network\Http\Client

Indirect Known Users

Cake\Auth\BasicAuthenticate, Cake\Auth\ControllerAuthorize, Cake\Cache\Engine\NullEngine, Cake\Cache\Engine\RedisEngine, Cake\Cache\Engine\WincacheEngine, Cake\Cache\Engine\XcacheEngine, Cake\Controller\Component\AuthComponent, Cake\Controller\Component\CookieComponent, Cake\Controller\Component\CsrfComponent, Cake\Controller\Component\FlashComponent, Cake\Controller\Component\PaginatorComponent, Cake\Controller\Component\RequestHandlerComponent, Cake\Auth\DefaultPasswordHasher, Cake\Controller\Component\SecurityComponent, Cake\Log\Engine\ConsoleLog, Cake\Log\Engine\FileLog, Cake\Log\Engine\SyslogLog, Cake\Mailer\Transport\DebugTransport, Cake\Mailer\Transport\MailTransport, Cake\Mailer\Transport\SmtpTransport, Cake\ORM\Behavior\CounterCacheBehavior, Cake\ORM\Behavior\TimestampBehavior, Cake\ORM\Behavior\TranslateBehavior, Cake\Auth\DigestAuthenticate, Cake\ORM\Behavior\TreeBehavior, Cake\Routing\Filter\AssetFilter, Cake\Routing\Filter\ControllerFactoryFilter, Cake\Routing\Filter\LocaleSelectorFilter, Cake\Routing\Filter\RoutingFilter, Cake\Shell\Helper\ProgressHelper, Cake\Shell\Helper\TableHelper, Cake\View\Helper\FlashHelper, Cake\View\Helper\FormHelper, Cake\View\Helper\HtmlHelper, Cake\Auth\FallbackPasswordHasher, Cake\View\Helper\NumberHelper, Cake\View\Helper\PaginatorHelper, Cake\View\Helper\RssHelper, Cake\View\Helper\SessionHelper, Cake\View\Helper\TextHelper, Cake\View\Helper\TimeHelper, Cake\View\Helper\UrlHelper, Cake\Auth\FormAuthenticate, Cake\Auth\WeakPasswordHasher, Cake\Cache\Engine\ApcEngine, Cake\Cache\Engine\FileEngine, Cake\Cache\Engine\MemcachedEngine
Namespace: Cake\Core
Located at Core/InstanceConfigTrait.php

Method Detail

_configDeletesource protected 

_configDelete( string $key )

Delete a single config key

Parameters

string $key
Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configReadsource protected 

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key
Key to read.

Returns

mixed
mixed

_configWritesource protected 

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Write a config variable

Parameters

string|array $key
Key to write to.
mixed $value
Value to write.
boolean|string $merge optional false
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

configsource public 

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

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']);

Parameters

string|array|null $key optional null
The key to get/set, or a complete array of configs.
mixed|null $value optional null
The value to set.
boolean $merge optional true
Whether to recursively merge or overwrite existing config, defaults to true.

Returns

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.

configShallowsource public 

configShallow( string|array $key , mixed|null $value null )

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->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']);

Parameters

string|array $key
The key to set, or a complete array of configs.
mixed|null $value optional null
The value to set.

Returns

mixed
$this The object itself.

Properties summary

$_configsource

protected array

Runtime config

[]

$_configInitializedsource

protected boolean

Whether the config property has already been configured with defaults

false

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Core.InstanceConfigTrait.html