Класс Configure

_appDefaults()source protected static

_appDefaults( )

Устанавливает конфигурации по умолчанию приложения

_getReader()source protected static

_getReader( string $config )

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

Параметры

строка $config

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

Возвращает

mixed
Экземпляр читателя или false

_setErrorHandlers()source protected static

_setErrorHandlers( array $error , array $exception )

Устанавливает обработчики ошибок и исключений.

Параметры

массив $error

Конфигурация обработки ошибок.

массив $exception

Конфигурация обработки исключений.

bootstrap()source public static

bootstrap( boolean $boot true )

Инициализирует configure и выполняет процесс загрузки. Загрузка включает следующие шаги:

• Настройка массива App в Configure.
• Включение app/Config/core.php.
• Настройка конфигурации кэша ядра.
• Загрузка файлов кэша приложения.
• Включение app/Config/bootstrap.php.
• Настройка обработчиков ошибок/исключений.

Параметры

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

Выполнять ли загрузку.

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 , ConfigReaderInterface $reader )

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

Для добавления нового читателя в Configure:

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

Параметры

строка $name

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

ConfigReaderInterface $reader

Читатель для добавления.

configured()source public static

configured( string|null $name null )

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

Параметры

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

Имя для проверки. Если null, возвращает все имена настроенных читателей.

Возвращает

array
Массив настроенных объектов-читателей.

consume()source public static

consume( string $var )

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

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

Параметры

строка $var

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

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

массив|null

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/2.0/ru/development/configuration.html#Configure::delete

drop()source public static

drop( string $name )

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

Параметры

строка $name

Имя ридера для удаления.

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

boolean
Успех

dump()source public static

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

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

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

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

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

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

Configure::dump('error.php', 'default', array('Error', 'Exception');

Параметры

строка $key

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

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

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

массив $keys необязательно array()

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

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

boolean
успех

Исключения

ConfigureException
если адаптер не реализует метод 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 конфигурация, и для нее еще не был настроен ридер, он будет автоматически создан с помощью PhpReader

Параметры

строка $key

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

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

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

boolean $merge необязательно true

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

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

boolean
Ложь, если файл не найден, истина, если загрузка прошла успешно.

Исключения

ConfigureException
Вызовет любые исключения, которые генерирует ридер.

Ссылка

https://book.cakephp.org/2.0/ru/development/configuration.html#Configure::load

read()source public static

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

Параметры

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

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

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

смешанное
значение, сохраненное в configure, или null.

Ссылка

https://book.cakephp.org/2.0/ru/development/configuration.html#Configure::read

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 $data null )

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

Параметры

строка $name

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

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

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

массив $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(array('One.key1' => 'value of the Configure::One[key1]'));
Configure::write('One', array(
    'key1' => 'value of the Configure::One[key1]',
    'key2' => 'value of the Configure::One[key2]'
);

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

Параметры

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

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

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

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

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

boolean
Истина, если запись прошла успешно

Ссылка

https://book.cakephp.org/2.0/ru/development/configuration.html#Configure::write

array()

array(
    'debug' => 0
)