Класс Configure

_getEngine()source protected static

_getEngine( string $config )

Получить настроенный движок. Внутренне используется Configure::load() и Configure::dump(). Создаст новый PhpConfig по умолчанию, если он еще не настроен.

Параметры

строка $config

Имя настроенного адаптера

Возвращает

Cake\Core\Configure\ConfigEngineInterface|false
Экземпляр движка или false

check()source public static

check( string $var )

Возвращает true, если заданная переменная установлена в Configure.

Параметры

строка $var

Имя переменной для проверки

Возвращает

boolean
True, если переменная существует

clear()source public static

clear( )

Очистить все значения, хранящиеся в Configure.

Возвращает

boolean
Успешно.

config()source public static

config( string $name , Cake\Core\Configure\ConfigEngineInterface $engine )

Добавить новый движок в Configure. Движки позволяют читать файлы конфигурации в различных форматах/местах хранения. CakePHP поставляется с двумя встроенными движками PhpConfig и IniConfig. Вы также можете реализовать собственные классы движков в своём приложении.

Для добавления нового движка в Configure:

Configure::config('ini', new IniConfig());

Параметры

строка $name

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

Cake\Core\Configure\ConfigEngineInterface $engine

Движок для добавления.

configured()source public static

configured( string|null $name = null )

Получает имена настроенных объектов Engine.

Параметры

строка|null $name необязательно null

Имя движка.

Возвращает

массив|boolean
Массив настроенных объектов Engine, bool для конкретного имени.

consume()source public static

consume( string $var )

Используется для чтения и удаления переменной из Configure.

В основном используется во время загрузки для перемещения данных конфигурации из configure в другие классы CakePHP.

Параметры

строка $var

Ключ для чтения и удаления.

Возвращает

массив|строка|null

consumeOrFail()source public static

consumeOrFail( string $var )

Используется для получения информации, хранящейся в Configure. Невозможно хранить значения null в Configure.

Действует как обёртка вокруг Configure::consume() и Configure::check(). Ожидается, что пара ключ/значение configure, потребляемая этим методом, существует. В случае отсутствия будет выброшено исключение.

Параметры

строка $var

Переменная для получения. Используйте '.' для доступа к элементам массива.

Возвращает

смешанное
Значение, хранящееся в configure.

Выбрасывает

RuntimeException
если запрошенная конфигурация не задана.

С версии

3.6.0

delete()source public static

delete( string $var )

Используется для удаления переменной из Configure.

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

Configure::delete('Name'); will delete the entire Configure::Name
Configure::delete('Name.key'); will delete only the Configure::Name[key]

Параметры

строка $var

переменная для удаления

Ссылка

https://book.cakephp.org/3.0/ru/development/configuration.html#deleting-configuration-data

drop()source public static

drop( string $name )

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

Параметры

строка $name

Имя движка для удаления.

Возвращает

boolean
Успех

dump()source public static

dump( string $key , string $config = 'default' , array $keys = [] )

Выводит данные, хранящиеся в Configure, в $key. Формат сериализации определяется движком конфигурации, прикрепленным как $config. Например, если адаптер 'default' — это PhpConfig, сгенерированный файл будет файлом конфигурации PHP, загружаемым PhpConfig.

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

Предположим, что движок 'default' — это экземпляр PhpConfig. Сохраните все данные из Configure в файл my_config.php:

Configure::dump('my_config', 'default');

Сохраните только конфигурацию обработки ошибок:

Configure::dump('error', 'default', ['Error', 'Exception'];

Параметры

строка $key

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

строка $config необязательно 'default'

Имя настроенного адаптера для вывода данных.

массив $keys необязательно []

Имя ключей верхнего уровня, которые вы хотите вывести. Это позволяет сохранить только некоторые данные, хранящиеся в Configure.

Возвращает

boolean
Успех

Выбрасывает

Cake\Core\Exception\Exception
если адаптер не реализует метод dump.

load()source public static

load( string $key , string $config = 'default' , boolean $merge = true )

Загружает сохраненную конфигурационную информацию из ресурса. Вы можете добавить движки ресурсов файлов конфигурации с помощью Configure::config().

Загруженная конфигурационная информация будет объединена с текущей конфигурацией выполнения. Вы можете загружать файлы конфигурации из плагинов, добавляя имя плагина перед именем файла.

Configure::load('Users.user', 'default')

Загрузит файл конфигурации 'user' с использованием стандартного движка конфигурации. Вы можете загружать файлы конфигурации приложения, указывая имя ресурса, который вы хотите загрузить.

Configure::load('setup', 'default');

Если используется default конфигурация, и для нее еще не настроен движок, он будет автоматически создан с помощью PhpConfig.

Параметры

строка $key

имя конфигурационного ресурса для загрузки.

строка $config необязательно 'default'

Имя настроенного движка для чтения ресурса, идентифицированного $key.

логическое значение $merge необязательно true

если файлы конфигурации должны быть объединены, а не просто перезаписаны

Возвращает

boolean
False, если файл не найден, true, если загрузка успешна.

Ссылка

https://book.cakephp.org/3.0/ru/development/configuration.html#reading-and-writing-configuration-files

read()source public static

read( string|null $var = null , mixed $default = null )

Используется для чтения информации, хранящейся в Configure. Невозможно хранить значения null в Configure.

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

Configure::read('Name'); will return all values for Name
Configure::read('Name.key'); will return only the value of Configure::Name[key]

Параметры

строка|null $var необязательно null

Переменная для получения. Используйте '.' для доступа к элементам массива.

смешанный $default необязательно null

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

Возвращает

mixed
Значение, хранящееся в configure, или null.

Ссылка

https://book.cakephp.org/3.0/ru/development/configuration.html#reading-configuration-data

readOrFail()source public static

readOrFail( string $var )

Используется для получения информации, хранящейся в Configure. Невозможно хранить значения null в Configure.

Выступает в качестве обёртки вокруг Configure::read() и Configure::check(). Ожидается, что пара ключ/значение конфигурации, извлечённая этим методом, существует. В противном случае будет выброшено исключение.

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

Configure::readOrFail('Name'); will return all values for Name
Configure::readOrFail('Name.key'); will return only the value of Configure::Name[key]

Параметры

строка $var

Переменная для получения. Используйте '.' для доступа к элементам массива.

Возвращает

mixed
Значение, хранящееся в configure.

Выбрасывает

RuntimeException
если запрошенная конфигурация не задана.

Ссылка

https://book.cakephp.org/3.0/ru/development/configuration.html#reading-configuration-data

restore()source public static

restore( string $name , string $cacheConfig = 'default' )

Восстанавливает данные конфигурации, сохранённые в кэше, в configure. Восстановленные значения перепишут существующие.

Параметры

строка $name

Имя сохранённого файла конфигурации для загрузки.

строка $cacheConfig необязательно 'default'

Имя конфигурации кэша для чтения.

Возвращает

boolean
Успех.

store()source public static

store( string $name , string $cacheConfig = 'default' , array|null $data = null )

Используется для записи конфигурации выполнения в кэш. Сохранённую конфигурацию выполнения можно восстановить с помощью Configure::restore(). Эти методы могут использоваться для включения интерфейсов конфигурации, или других интерфейсов типа GUI для конфигурации.

Параметры

строка $name

Имя хранилища сохранённой конфигурации.

строка $cacheConfig необязательно 'default'

Конфигурация кэша для сохранения. По умолчанию 'default'

массив|null $data необязательно null

Либо массив данных для хранения, либо оставить пустым, чтобы сохранить все значения.

Возвращает

boolean
Успех

version()source public static

version( )

Используется для определения текущей версии CakePHP.

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

Configure::version();

Возвращает

строка
Текущая версия CakePHP

write()source public static

write( string|array $config , mixed $value = null )

Используется для хранения динамической переменной в Configure.

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

Configure::write('One.key1', 'value of the Configure::One[key1]');
Configure::write(['One.key1' => 'value of the Configure::One[key1]']);
Configure::write('One', [
    'key1' => 'value of the Configure::One[key1]',
    'key2' => 'value of the Configure::One[key2]'
]);

Configure::write([
    'One.key1' => 'value of the Configure::One[key1]',
    'One.key2' => 'value of the Configure::One[key2]'
]);

Параметры

строка|массив $config

Ключ для записи, может быть значением с точечной нотацией. Также может быть массивом, содержащим ключ(и) и значение(я).

смешанный $value необязательно null

Значение для установки для var

Возвращает

boolean
True, если запись выполнена успешно

Ссылка

https://book.cakephp.org/3.0/ru/development/configuration.html#writing-configuration-data

[]

[
    'debug' => false
]