Spec-Zone.ru › CakePHP 4.4

Класс IniConfig

Двигатель конфигурации файла ini.

Поскольку IniConfig использует parse_ini_file внутри, вы должны знать, что этот класс имеет такое же поведение, особенно в отношении значений boolean и null.

В дополнение к родным parse_ini_file функциям, IniConfig также позволяет создавать вложенные массивы с помощью разделителей . в именах. Это позволяет создавать вложенные структуры массивов в файле конфигурации ini. Например:

db.password = secret превратится в ['db' => ['password' => 'secret']]

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

[section]
key = value

После загрузки в Configure, вышеперечисленное можно получить, используя:

`Configure::read('section.key');

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

IniConfig также управляет тем, как обрабатываются специальные значения ini 'yes', 'no', 'on', 'off', 'null'. Эти значения будут преобразованы в их булевы эквиваленты.

Пространство имён: Cake\Core\Configure\Engine
См.: https://secure.php.net/parse_ini_file

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

  • $_extension protected
    string

    Расширение файла.

  • $_path protected
    string

    Путь, по которому этот движок находит файлы.

  • $_section protected
    string|null

    Секция для чтения, если null, все секции будут считаны.

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

  • __construct() public

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

  • _getFilePath() protected

    Получить путь к файлу

  • _parseNestedValues() protected

    Парсит вложенные значения из ключей.

  • _value() protected

    Преобразует значение в эквивалент ini.

  • dump() public

    Выводит состояние данных Configure в строку формата ini.

  • read() public

    Прочитать файл ini и вернуть результаты в виде массива.

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

__construct() public

__construct(string|null $path = null, string|null $section = null)

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

Параметры

string|null $path optional

Путь для загрузки файлов конфигурации ini. По умолчанию CONFIG.

string|null $section optional

Получить только одну секцию, оставить null, чтобы разобрать и получить все секции в файле ini.

_getFilePath() protected

_getFilePath(string $key, bool $checkExists = false): string

Получить путь к файлу

Параметры

string $key

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

bool $checkExists optional

Требуется ли проверка существования файла. По умолчанию false.

Возвращает

string

Выбрасывает

Cake\Core\Exception\CakeException
Когда файлы не существуют или когда файлы содержат '..', что может привести к злоупотреблению чтением.

_parseNestedValues() protected

_parseNestedValues(array $values): array

Парсит вложенные значения из ключей.

Параметры

array $values

Значения для разбиения.

Возвращает

array

_value() protected

_value(mixed $value): string

Преобразует значение в эквивалент ini.

Параметры

mixed $value

Значение для экспорта.

Возвращает

string

dump() public

dump(string $key, array $data): bool

Выводит состояние данных Configure в строку формата ini.

Параметры

string $key

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

array $data

Данные для преобразования в файл ini.

Возвращает

bool

read() public

read(string $key): array

Прочитать файл ini и вернуть результаты в виде массива.

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

Параметры

string $key

Идентификатор для чтения. Если ключ содержит ., он будет обрабатываться как префикс плагина. Выбранный файл должен находиться в пути движка.

Возвращает

array

Выбрасывает

Cake\Core\Exception\CakeException
при отсутствии файлов. Или когда файлы содержат '..', что может привести к злоупотреблению чтением.

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

$_extension protected

Расширение файла.

Тип

string

$_path protected

Путь, по которому этот движок находит файлы.

Тип

string

$_section protected

Секция для чтения, если null, все секции будут считаны.

Тип

string|null

© 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.Engine.IniConfig.html

Spec-Zone.ru

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