Класс Configure

_getEnginesource protected static

_getEngine( string $config )

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

Параметры

строка $config

Имя сконфигурированного адаптера

Возвращаемое значение

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

checksource public static

check( string $var )

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

Параметры

строка $var

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

Возвращаемое значение

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

clearsource public static

clear( )

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

Возвращаемое значение

boolean
Успешно.

configsource 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

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

configuredsource public static

configured( string|null $name null )

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

Параметры

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

Имя движка.

Возвращаемое значение

array
Массив сконфигурированных объектов Engine.

consumesource public static

consume( string $var )

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

В основном используется во время загрузки, чтобы перенести данные конфигурации из Configure в различные другие классы в CakePHP.

Параметры

строка $var

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

Возвращаемое значение

array|null
массив|null

deletesource 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

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

Ссылка

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

dropsource public static

drop( string $name )

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

Параметры

строка $name

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

Возвращаемое значение

boolean
Успешно

dumpsource 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.

loadsource 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, если загрузка прошла успешно.

Ссылка

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

readsource public static

read( string $var 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]

Параметры

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

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

Возвращаемое значение

mixed
Значение, хранящееся в конфигурации, или null.

Ссылка

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

readOrFailsource 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
Значение, хранящееся в конфигурации.

Выбрасывает

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

Ссылка

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

restoresource public static

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

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

Параметры

строка $name

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

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

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

Возвращаемое значение

boolean
Успех.

storesource public static

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

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

Параметры

строка $name

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

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

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

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

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

Возвращаемое значение

boolean
Успех

versionsource public static

version( )

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

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

Configure::version();

Возвращаемое значение

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

writesource 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, если запись прошла успешно

Ссылка

http://book.cakephp.org/3.0/en/development/configuration.html#writing-configuration-data

[]

null

[
    'debug' => false
]