Трейт StaticConfigTrait
Трейт, предоставляющий набор статических методов для управления конфигурацией для классов, которые предоставляют фасад адаптера или нуждаются в регистрации и манипулировании наборами данных конфигурации.
Ожидается, что реализующие объекты объявят статическую $_dsnClassMap собственность.
Прямые пользователи
Краткое описание свойств
- Наборы конфигурации.
array
Краткое описание методов
-
Этот метод можно использовать для определения адаптеров конфигурации для приложения или чтения существующей конфигурации.
- Возвращает массив, содержащий именованные конфигурации
- Удаляет построенный адаптер.
- Возвращает или обновляет карту классов DSN для этого класса.
- Читает существующую конфигурацию.
- Возвращает карту классов DSN для этого класса.
- Разбирает 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);
Устаревшее
3.4.0 Используйте setConfig()/getConfig() вместо этого.Параметры
- строка|массив
$key - Имя конфигурации или массив из нескольких конфигураций.
- массив|null
$configнеобязательно null - Массив имя => данные конфигурации для адаптера.
Возвращает
массив|nullNull при добавлении конфигурации или массив данных конфигурации при чтении.
Возбуждает
BadMethodCallExceptionПри попытке изменить существующую конфигурацию.
configured()source public static
configured( )
Возвращает массив, содержащий именованные конфигурации
Возвращает
массивМассив конфигураций.
drop()source public static
drop( string $config )
Удаляет построенный адаптер.
Если вы хотите изменить существующую конфигурацию, вы должны удалить её, изменить конфигурацию, а затем повторно добавить.
Если реализующие объекты поддерживают объект $_registry, именованная конфигурация также будет удалена из реестра.
Параметры
- строка
$config - Существующая конфигурация, которую вы хотите удалить.
Возвращает
булевоУспех удаления, возвращает false, если конфигурация не существует.
dsnClassMap()source public static
dsnClassMap( array $map null )
Возвращает или обновляет карту классов DSN для этого класса.
Устаревшее
3.4.0 Используйте setDsnClassMap()/getDsnClassMap() вместо этого.Параметры
- массив
$mapнеобязательно null - Добавления/изменения в карту классов для применения.
Возвращает
массивgetConfig()source public static
getConfig( string $key )
Читает существующую конфигурацию.
Параметры
- строка
$key - Имя конфигурации.
Возвращает
массив|nullМассив данных конфигурации.
getDsnClassMap()source public static
getDsnClassMap( )
Возвращает карту классов DSN для этого класса.
Возвращает
массив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, если не указано иначе.
Обратите внимание, что параметры запроса также анализируются и устанавливаются как значения в возвращаемой конфигурации.
Параметры
- строка
$dsn - Строка DSN для преобразования в массив конфигурации
Возвращает
массивМассив конфигурации для хранения после разбора DSN
Возбуждает
InvalidArgumentExceptionЕсли не передана строка или передана некорректная строка
setConfig()source public static
setConfig( string|array $key , array $config null )
Этот метод можно использовать для определения адаптеров конфигурации для приложения.
Чтобы изменить конфигурацию адаптера во время выполнения, сначала удалите адаптер, а затем переконфигурируйте его.
Адаптеры не будут построены до выполнения первого действия.
Использование
Предполагая, что имя класса — Cache, поддерживаются следующие сценарии:
Настройка движка кэша.
Cache::setConfig('default', $settings); Вставка построенного адаптера:
Cache::setConfig('default', $instance); Настройка нескольких адаптеров одновременно:
Cache::setConfig($arrayOfConfig);
Параметры
- строка|массив
$key - Имя конфигурации или массив из нескольких конфигураций.
- массив
$configнеобязательно null - Массив имя => данные конфигурации для адаптера.
Возбуждает
BadMethodCallExceptionПри попытке изменить существующую конфигурацию.
LogicException
При попытке сохранить некорректный структурированный массив конфигурации.
setDsnClassMap()source public static
setDsnClassMap( array $map )
Обновляет карту классов DSN для этого класса.
Параметры
- массив
$map - Добавления/изменения в карту классов для применения.
Подробное описание свойств
© 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.4/class-Cake.Core.StaticConfigTrait.html