Spec-Zone.ru › CakePHP 3.3

Трейт StaticConfigTrait

Трейт, который предоставляет набор статических методов для управления конфигурацией для классов, предоставляющих фасад адаптера или нуждающихся в регистрации и манипулировании наборами данных конфигурации.

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

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

  • Cake\Cache\Cache
  • Cake\Datasource\ConnectionManager
  • Cake\Log\Log
  • Cake\Mailer\Email
Пространство имен: Cake\Core
Расположение: Core/StaticConfigTrait.php

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

  • $_config protected static
    array
    Наборы конфигурации.

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

  • config() public static

    Этот метод можно использовать для определения адаптеров конфигурации для приложения или чтения существующей конфигурации.

  • configured() public static
    Возвращает массив, содержащий именованные конфигурации
  • drop() public static
    Удаляет созданный адаптер.
  • dsnClassMap() public static
    Возвращает или обновляет карту классов DSN для этого класса
  • parseDsn() public static
    Парсит DSN в корректную конфигурацию подключения

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

config()source public static

config( string|array $key , array|null $config null )

Этот метод можно использовать для определения адаптеров конфигурации для приложения или чтения существующей конфигурации.

Чтобы изменить конфигурацию адаптера во время выполнения, сначала удалите адаптер, а затем переконфигурируйте его.

Адаптеры не будут созданы до тех пор, пока первое действие не будет выполнено.

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

Предполагая, что имя класса Cache поддерживаются следующие сценарии:

Чтение данных конфигурации обратно:

Cache::config('default');

Настройка движка кеширования.

Cache::config('default', $settings);

Вставка созданного адаптера:

Cache::config('default', $instance);

Настройка нескольких адаптеров одновременно:

Cache::config($arrayOfConfig);

Параметры

string|array $key
Имя конфигурации или массив из нескольких конфигураций.
array|null $config необязательно null
Массив пар имя => данные конфигурации для адаптера.

Возвращает

array|null
Null при добавлении конфигурации или массив данных конфигурации при чтении.

Выбрасывает

BadMethodCallException
При попытке модифицировать существующую конфигурацию.

configured()source public static

configured( )

Возвращает массив, содержащий именованные конфигурации

Возвращает

array
Массив конфигураций.

drop()source public static

drop( string $config )

Удаляет созданный адаптер.

Если вы хотите изменить существующую конфигурацию, вы должны удалить ее, изменить конфигурацию, а затем добавить ее заново.

Если реализующие объекты поддерживают объект $_registry, то именованная конфигурация также будет выгружена из реестра.

Параметры

string $config
Существующая конфигурация, которую вы хотите удалить.

Возвращает

boolean
Успешность удаления, возвращает false, если конфигурация не существует.

dsnClassMap()source public static

dsnClassMap( array $map null )

Возвращает или обновляет карту классов DSN для этого класса

Параметры

array $map необязательно null
Добавления/изменения в карте классов для применения

Возвращает

array

parseDsn()source public static

parseDsn( string $dsn )

Парсит DSN в корректную конфигурацию подключения

Этот метод позволяет задать DSN с форматированием, похожим на используемое PEAR::DB. Ниже приведен пример его использования:

$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);

$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);

$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);

$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);

$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);

Для всех классов значение scheme устанавливается как значение className, если не указано иное.

Обратите внимание, что аргументы querystring также анализируются и устанавливаются как значения в возвращаемой конфигурации.

Параметры

string $dsn
Строка DSN для преобразования в массив конфигурации

Возвращает

array
Массив конфигурации для хранения после анализа DSN

Выбрасывает

InvalidArgumentException
Если не передана строка

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

$_configsource

protected static array

Наборы конфигурации.

[]

© 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.StaticConfigTrait.html

Spec-Zone.ru

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