Класс 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.

Проверка, настроен ли конкретный движок с помощью этого метода, устарела. Используйте Configure::isConfigured() вместо этого.

Параметры

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

Имя движка.

Возвращает

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

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(). Ожидается, что пара ключ/значение конфигурации, извлеченная с помощью этого метода, будет существовать. В случае отсутствия будет выброшено исключение.

Параметры

строка $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]

Параметры

string $var

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

Ссылка

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

drop()source public static

drop( string $name )

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

Параметры

string $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'];

Параметры

string $key

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

string $config необязательно 'default'

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

array $keys необязательно []

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

Возвращает

boolean
Успех

Выбрасывает

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

isConfigured()source public static

isConfigured( string $name )

Возвращает true, если объект Engine настроен.

Параметры

string $name

Имя движка.

Возвращает

boolean

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

Параметры

string $key

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

string $config необязательно 'default'

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

boolean $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]

Параметры

string|null $var необязательно null

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

mixed $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]

Параметры

string $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. Восстановленные значения перезапишут существующие.

Параметры

string $name

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

string $cacheConfig необязательно 'default'

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

Возвращает

boolean
Успех.

store()source public static

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

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

Параметры

string $name

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

string $cacheConfig необязательно 'default'

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

array|null $data необязательно null

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

Возвращает

boolean
Успех

version()source public static

version( )

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

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

Configure::version();

Возвращает

string
Текущая версия 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]'
]);

Параметры

string|array $config

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

mixed $value необязательно null

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

Возвращает

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

Ссылка

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

[]

[
    'debug' => false
]