Трейт StaticConfigTrait
Трейт, который предоставляет набор статических методов для управления конфигурацией для классов, предоставляющих фасад адаптера или нуждающихся в регистрации и манипулировании наборами данных конфигурации.
Ожидается, что реализующие объекты объявят статическое свойство $_dsnClassMap.
Прямые пользователи
Краткое описание свойств
- Наборы конфигурации.
array
Краткое описание методов
-
Этот метод можно использовать для определения адаптеров конфигурации для приложения или чтения существующей конфигурации.
- Возвращает массив, содержащий именованные конфигурации
- Удаляет созданный адаптер.
- Возвращает или обновляет карту классов DSN для этого класса
- Парсит 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|nullNull при добавлении конфигурации или массив данных конфигурации при чтении.
Выбрасывает
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 - Добавления/изменения в карте классов для применения
Возвращает
arrayparseDsn()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Если не передана строка
Подробное описание свойств
© 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