Trait InstanceConfigTrait
A trait for reading and writing instance config
Implementing objects are expected to declare a $_defaultConfig property.
Direct Users
- Cake\Auth\AbstractPasswordHasher
- Cake\Auth\BaseAuthenticate
- Cake\Http\Client
- Cake\Log\Engine\BaseLog
- Cake\Mailer\AbstractTransport
- 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\Datasource\Paginator
- Cake\Error\Debugger
- Cake\Error\Middleware\ErrorHandlerMiddleware
Indirect Users
- Cake\Auth\BasicAuthenticate
- Cake\Auth\ControllerAuthorize
- Cake\Cache\Engine\MemcachedEngine
- 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\Auth\DefaultPasswordHasher
- Cake\Controller\Component\RequestHandlerComponent
- 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\Auth\DigestAuthenticate
- Cake\ORM\Behavior\TranslateBehavior
- 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\TestSuite\TestEmailTransport
- Cake\View\Helper\BreadcrumbsHelper
- Cake\Auth\FallbackPasswordHasher
- Cake\View\Helper\FlashHelper
- Cake\View\Helper\FormHelper
- Cake\View\Helper\HtmlHelper
- 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\ApcuEngine
- Cake\Cache\Engine\ArrayEngine
- Cake\Cache\Engine\FileEngine
Properties summary
-
$_configprotectedarrayRuntime config -
$_configInitializedprotectedbooleanWhether the config property has already been configured with defaults
Method Summary
-
_configDelete() protected
Deletes a single config key. -
_configRead() protected
Reads a config key. -
_configWrite() protected
Writes a config key. -
config() public deprecated
Gets/Sets the config. -
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getConfig() public
Returns the config. -
setConfig() public
Sets the config.
Method Detail
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Writes a config key.
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
config() public deprecated ¶
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
Gets/Sets the config.
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']);
Deprecated
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
Config value being read, or the object itself on write operations.
Throws
configShallow() 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->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']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key = null , mixed $default = null )
Returns the config.
Usage
Reading the whole config:
$this->getConfig();
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');
Parameters
- string|null $key optional null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Configuration data at the named key or null if the key does not exist.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
Sets the config.
Usage
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']);
Parameters
- string|array $key
- The key to 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
$this
Throws
Properties detail
$_configInitialized ¶
Whether the config property has already been configured with defaults
false