Spec-Zone.ru › CakePHP 4.4

Класс Configure

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

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

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

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

  • $_engines protected static
    arrayCake\Core\Configure\ConfigEngineInterface>

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

  • $_hasIniSet protected static
    bool|null

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

  • $_values protected static
    array<string, mixed>

    Массив значений, в настоящее время хранящихся в 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

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

  • store() public static

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

  • version() public static

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

  • write() public static

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

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

_getEngine() protected static 

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

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

Параметры

string $config

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

Возвращает

Cake\Core\Configure\ConfigEngineInterface|null

check() public static 

check(string $var): bool

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

Параметры

string $var

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

Возвращает

bool

clear() public static 

clear(): void

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

Возвращает

void

config() public static 

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

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

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

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

Параметры

string $name

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

Cake\Core\Configure\ConfigEngineInterface $engine

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

Возвращает

void

configured() public static 

configured(): array<string>

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

Возвращает

array<string>

consume() public static 

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

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

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

Параметры

string $var

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

Возвращает

array|string|null

consumeOrFail() public static 

consumeOrFail(string $var): mixed

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

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

Параметры

string $var

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

Возвращает

mixed

Выбрасывает

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]

Параметры

string $var

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

Возвращает

void

Ссылки

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

drop() public static 

drop(string $name): bool

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

Параметры

string $name

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

Возвращает

bool

dump() public static 

dump(string $key, string $config = 'default', array<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'];

Параметры

string $key

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

string $config optional

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

array<string> $keys optional

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

Возвращает

bool

Выбрасывает

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

isConfigured() public static 

isConfigured(string $name): bool

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

Параметры

string $name

Имя движка.

Возвращает

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

Параметры

string $key

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

string $config optional

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

bool $merge optional

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

Возвращает

bool

Выбрасывает

Cake\Core\Exception\CakeException
если движок $config не найден

Ссылки

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]

Параметры

string|null $var optional

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

mixed $default optional

Возвращаемое значение, когда конфигурация не существует

Возвращает

mixed

Ссылки

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]

Параметры

string $var

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

Возвращает

mixed

Выбрасывает

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

Ссылки

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(). Эти методы могут использоваться для включения фронтендов менеджеров конфигурации или других интерфейсов типа графического интерфейса пользователя для конфигурации.

Параметры

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

Параметры

array<string, mixed>|string $config

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

mixed $value optional

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

Возвращает

void

Ссылки

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

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

$_engines protected static

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

Тип

arrayCake\Core\Configure\ConfigEngineInterface>

$_hasIniSet protected static

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

Тип

bool|null

$_values protected static

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

Тип

array<string, mixed>

© 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.4/class-Cake.Core.Configure.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API