Трейт InstanceConfigTrait
Трейт для чтения и записи конфигурации экземпляра
Реализующие объекты должны объявить свойство $_defaultConfig.
Прямые пользователи
- Cake\Auth\AbstractPasswordHasher
- Cake\Auth\BaseAuthenticate
- Cake\Network\Socket
- Cake\ORM\Behavior
- Cake\Routing\DispatcherFilter
- Cake\View\Helper
- 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
Краткое описание свойств
-
$_configprotectedКонфигурация выполненияarray -
$_configInitializedprotectedКонфигурировано ли свойство config значениями по умолчаниюboolean
Краткое описание методов
- _configDelete() protectedУдалить ключ конфигурации
- _configRead() protectedПрочитать переменную конфигурации
- _configWrite() protectedЗаписать переменную конфигурации
- config() publicИспользование
- configShallow() public
Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от
config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
Подробное описание методов
_configDelete()source protected
_configDelete( string $key )
Удалить ключ конфигурации
Параметры
- строка
$key - Ключ для удаления.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписать существующую конфигурацию
_configRead()source protected
_configRead( string|null $key )
Прочитать переменную конфигурации
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанный_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Записать переменную конфигурации
Параметры
- строка|массив
$key - Ключ для записи.
- смешанный
$value - Значение для записи.
- boolean|строка
$mergeнеобязательно false Истина для рекурсивного объединения, 'shallow' для простого объединения, ложь для перезаписи, по умолчанию ложь.
Исключения
Cake\Core\Exception\Exceptionпри попытке перезаписать существующую конфигурацию
config()source 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']);
Параметры
- строка|массив|null
$keyнеобязательно null - Ключ для получения/установки или полный массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять ли рекурсивное объединение или перезаписывать существующую конфигурацию, по умолчанию - истина.
Возвращает
смешанныйЗначение конфигурации, которое считывается или сам объект при операциях записи.
Исключения
Cake\Core\Exception\ExceptionПри попытке установить неверный ключ.
configShallow()source 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 - Значение для установки.
Возвращает
$this Сам объект.
Подробное описание свойств
$_configInitializedsource
protected boolean
Указывает, была ли конфигурация уже настроена по умолчанию
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.2/class-Cake.Core.InstanceConfigTrait.html