Spec-Zone.ru › CakePHP 3.1

Трейт InstanceConfigTrait

Трейт для чтения и записи конфигурации экземпляра

Ожидается, что реализующие объекты объявят свойство $_defaultConfig.

Прямые известные пользователи

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

Косвенные известные пользователи

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
Пространство имен: Cake\Core
Расположение Core/InstanceConfigTrait.php

Подробное описание метода

_configDeletesource protected

_configDelete( string $key )

Удалить один ключ конфигурации

Параметры

string $key
Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписать существующую конфигурацию

_configReadsource protected

_configRead( string|null $key )

Прочитать переменную конфигурации

Параметры

string|null $key
Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

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

Записать переменную конфигурации

Параметры

string|array $key
Ключ для записи.
mixed $value
Значение для записи.
boolean|string $merge необязательно false
Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

configsource public

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

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array|null $key необязательно null
Ключ для получения/установки или массив всей конфигурации.
mixed|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Выполнять ли рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию истина.

Возвращает

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallowsource public

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

Объединить предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key
Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно null
Значение для установки.

Возвращает

mixed
Сам объект.

Краткое описание свойств

$_configsource

protected массив

Конфигурация в реальном времени

[]

$_configInitializedsource

protected логическое

Установлена ли конфигурация свойства значениями по умолчанию

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API