Класс IniConfig

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

Поскольку IniConfig использует parse_ini_file, вы должны знать, что этот класс имеет такое же поведение, особенно в отношении логических значений и значений 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\IniConfig реализует Cake\Core\Configure\ConfigEngineInterface использует Cake\Core\Configure\FileConfigTrait

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

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

$_extension protected

string
Расширение файла.
$_section protected

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

Унаследованные свойства

_path

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

__construct() public

Создать и сконструировать новый парсер файлов ini. Парсер может быть использован для чтения файлов ini, которые находятся в файловой системе.
_parseNestedValues() protected
Парсит вложенные значения из ключей.
_value() protected
Преобразует значение в эквивалент ini
dump() public
Выводит состояние данных Configure в строку в формате ini.
read() public
Прочитать файл ini и вернуть результаты в виде массива.

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

__construct()source public

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

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

Параметры

строка|null $path необязательный null: Путь для загрузки файлов конфигурации ini. По умолчанию CONFIG.
строка|null $section необязательный null: Получить только одну секцию, оставьте null, чтобы разобрать и получить все секции в файле ini.

_parseNestedValues()source protected

_parseNestedValues( array $values )

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

Параметры

массив $values: Значения для разделения.

Возвращает

массив
Массив разделенных значений

_value()source protected

_value( mixed $value )

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

Параметры

смешанный $value: Значение для экспорта.

Возвращает

строка
Строковое значение для файла ini.

dump()source public

dump( string $key , array $data )

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

Параметры

строка $key: Идентификатор для записи. Если ключ содержит '.', он будет интерпретироваться как префикс плагина.
массив $data: Данные для преобразования в файл ini.

Возвращает

булево
Успех.

Реализация

Cake\Core\Configure\ConfigEngineInterface::dump()

read()source public

read( string $key )

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

Параметры

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

Возвращает

массив
Разбор значений конфигурации.

Использует

Cake\Core\Exception\Exception

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

Реализация

Cake\Core\Configure\ConfigEngineInterface::read()

Используемые методы из Cake\Core\Configure\FileConfigTrait

_getFilePath()source protected

_getFilePath( string $key , boolean $checkExists = false )

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

Параметры

строка $key: Идентификатор для записи. Если ключ содержит '.', он будет интерпретироваться как префикс плагина.
булево $checkExists необязательный false: Проверять, существует ли файл. По умолчанию false.

Возвращает

строка
Полный путь к файлу

Использует

Cake\Core\Exception\Exception

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

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

$_extensionsource

protected строка

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

'.ini'

$_sectionsource

protected строка|null

Секция для чтения, если 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/3.8/class-Cake.Core.Configure.Engine.IniConfig.html