Spec-Zone.ru › CakePHP 3.3

Трейт InstanceConfigTrait

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

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

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

  • Cake\Auth\AbstractPasswordHasher
  • Cake\Auth\BaseAuthenticate
  • 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\Error\Middleware\ErrorHandlerMiddleware
  • Cake\Http\Client
  • Cake\Log\Engine\BaseLog

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

  • 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\BreadcrumbsHelper
  • Cake\View\Helper\FlashHelper
  • Cake\View\Helper\FormHelper
  • Cake\Auth\FallbackPasswordHasher
  • 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\ApcEngine
  • Cake\Cache\Engine\FileEngine
  • Cake\Cache\Engine\MemcachedEngine
Пространство имён: Cake\Core
Расположение: Core/InstanceConfigTrait.php

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

  • $_config protected
    array
    Конфигурация времени выполнения
  • $_configInitialized protected
    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

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

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
Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

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

Исключения

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

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 optional null
Значение для установки.

Возвращаемое значение


$this Объект самого себя.

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

$_configsource

protected array

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

[]

$_configInitializedsource

protected boolean

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

false

© 2005–2017 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.
https://api.cakephp.org/3.3/class-Cake.Core.InstanceConfigTrait.html

Spec-Zone.ru

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