Класс Configure

_appDefaultsисходный код защищенный статический

_appDefaults( )

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

_getReaderисходный код защищенный статический

_getReader( string $config )

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

Параметры

строка $config

Название настроенного адаптера

Возвращает

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

_setErrorHandlersисходный код защищенный статический

_setErrorHandlers( array $error , array $exception )

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

Параметры

массив $error

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

массив $exception

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

bootstrapисходный код публичный статический

bootstrap( boolean $boot true )

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

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

Параметры

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

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

checkисходный код публичный статический

check( string $var )

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

Параметры

строка $var

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

Возвращает

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

clearисходный код публичный статический

clear( )

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

Возвращает

boolean
Успех.

configисходный код публичный статический

config( string $name , ConfigReaderInterface $reader )

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

Чтобы добавить новый ридер в Configure:

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

Параметры

строка $name

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

ConfigReaderInterface $reader

Ридер для добавления.

configuredисходный код публичный статический

configured( string|null $name null )

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

Параметры

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

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

Возвращает

array
Массив настроенных объектов ридеров.

consumeисходный код публичный статический

consume( string $var )

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

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

Параметры

строка $var

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

Возвращает

array|null
массив|null

deleteисходный код публичный статический

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

dropисходный код публичный статический

drop( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
Успех

dumpисходный код публичный статический

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исходный код публичный статический

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.

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

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

Возвращает

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

Изучает

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

Ссылка

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

readsource 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]

Параметры

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

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

Возвращает

mixed
сохраненное в конфигурации значение или null.

Ссылка

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

restoresource public static

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

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

Параметры

string $name

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

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

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

Возвращает

boolean
Успех.

storesource public static

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

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

Параметры

string $name

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

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

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

array $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(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]'
));

Параметры

string|array $config

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

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

Значение для установки переменной

Возвращает

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

Ссылка

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

array()

array(
    'debug' => 0
)