Характеристика StaticConfigTrait

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

Массив с именем => данными конфигурации для адаптера.

Возвращает

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

Исключения

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

configured()source public static

configured( )

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

Возвращает

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

drop()source public static

drop( string $config )

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

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

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

Параметры

строка $config

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

Возвращает

boolean
Результат удаления, возвращает 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

Добавления/изменения в карту классов для применения.

[]