Класс Configure

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

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

Пространство имен: Cake\Core
Ссылка: https://book.cakephp.org/4/ru/development/configuration.html

Краткое описание свойств

$_engines protected static

Cake\Core\Configure\ConfigEngineInterface[]

Настроенные классы движка, используемые для загрузки файлов конфигурации из ресурсов
$_hasIniSet protected static

bool|null

Флаг для отслеживания наличия функции ini_set.
$_values protected static

array

Массив значений, в настоящее время хранящихся в Configure.

Краткое описание методов

_getEngine() protected static

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

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

Очистить все значения, хранящиеся в Configure.
config() public static

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

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

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

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

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

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

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

Возвращает true, если объекты Engine настроены.
load() public static

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

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

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

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

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

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

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

END_OF_DOCUMENT_MARKER

Подробное описание методов

_getEngine() protected static

_getEngine(string $config): Cake\Core\Configure\ConfigEngineInterface|null

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

Parameters

string $config: Имя настроенного адаптера

Returns

Cake\Core\Configure\ConfigEngineInterface|null

check() public static

check(string $var): bool

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

Parameters

string $var: Имя переменной для проверки

Returns

bool

clear() public static

clear(): void

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

Returns

void

config() public static

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

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

Чтобы добавить новый движок в Configure:

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

Parameters

string $name: Имя настраиваемого движка. Этот псевдоним используется позже для чтения значений из определенного движка.
Cake\Core\Configure\ConfigEngineInterface $engine: Движок для добавления.

Returns

void

configured() public static

configured(): string[]

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

Returns

string[]

consume() public static

consume(string $var): array|string|null

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

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

Parameters

string $var: Ключ для чтения и удаления.

Returns

array|string|null

consumeOrFail() public static

consumeOrFail(string $var): mixed

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

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

Parameters

string $var: Переменная для использования. Используйте «.» для доступа к элементам массива.

Returns

mixed

Throws

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

delete() public static

delete(string $var): void

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

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

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

Parameters

string $var: переменная для удаления

Returns

void

Links

https://book.cakephp.org/4/en/development/configuration.html#deleting-configuration-data

drop() public static

drop(string $name): bool

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

Parameters

string $name: Имя движка для удаления.

Returns

bool

dump() public static

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

Сохранить данные, находящиеся в данный момент в Configure, в $key. Формат сериализации определяется подключенным движком конфигурации как $config. Например, если адаптер «default» является PhpConfig, сгенерированный файл будет конфигурационным файлом PHP, загружаемым PhpConfig.

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

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

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

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

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

Parameters

string $key: Идентификатор для создания в адаптере конфигурации. Это может быть имя файла или ключ кэша в зависимости от используемого адаптера.
string $config optional: Имя настроенного адаптера для сохранения данных.
string[] $keys optional: Имя ключей верхнего уровня, которые вы хотите сохранить. Это позволяет сохранить только некоторые данные, хранящиеся в Configure.

Returns

bool

Throws

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

isConfigured() public static

isConfigured(string $name): bool

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

Parameters

string $name: Имя движка.

Returns

bool

load() public static

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

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

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

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

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

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

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

Parameters

string $key: имя ресурса конфигурации для загрузки.
string $config optional: Имя настроенного движка, который нужно использовать для чтения ресурса, идентифицированного $key.
bool $merge optional: нужно ли объединять файлы конфигурации вместо простого переопределения

Returns

bool

Links

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

read() public static

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

Используется для чтения информации, хранящейся в 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]

Parameters

string|null $var optional: Переменная для получения. Используйте «.» для доступа к элементам массива.
mixed $default optional: Возвращаемое значение, когда конфигурация не существует

Returns

mixed

Links

https://book.cakephp.org/4/en/development/configuration.html#reading-configuration-data

readOrFail() public static

readOrFail(string $var): mixed

Используется для получения информации, хранящейся в 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]

Parameters

string $var: Переменная для получения. Используйте «.» для доступа к элементам массива.

Returns

mixed

Throws

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

Links

https://book.cakephp.org/4/en/development/configuration.html#reading-configuration-data

restore() public static

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

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

Параметры

string $name: Имя сохранённого файла конфигурации для загрузки.
string $cacheConfig optional: Имя конфигурации кэша для чтения.

Возвращает

bool

Выбрасывает

RuntimeException

store() public static

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

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

Параметры

string $name: Имя хранилища сохранённой конфигурации.
string $cacheConfig optional: Конфигурация кэша для сохранения. По умолчанию «default».
array|null $data optional: Массив данных для сохранения или оставьте пустым, чтобы сохранить все значения.

Возвращает

bool

Выбрасывает

RuntimeException

version() public static

version(): string

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

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

Configure::version();

Возвращает

string

write() public static

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

Используется для хранения динамической переменной в 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 optional: Значение для установки переменной

Возвращает

void

Ссылки

https://book.cakephp.org/4/en/development/configuration.html#writing-configuration-data

Подробности свойств

`$_engines` protected static

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

Тип

Cake\Core\Configure\ConfigEngineInterface[]

`$_hasIniSet` protected static

Флаг для отслеживания наличия ini_set.

Тип

bool|null

`$_values` protected static

Массив значений, текущих в Configure.

Тип

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Core.Configure.html