Класс 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». Эти значения будут преобразованы в их эквиваленты boolean.

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, которые находятся на файловой системе.

Параметры

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

_parseNestedValues()source protected

_parseNestedValues( array $values )

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

Параметры

array $values: Значения для разбиения.

Возвращает

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

_value()source protected

_value( mixed $value )

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

Параметры

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

Возвращает

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

dump()source public

dump( string $key , array $data )

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

Параметры

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

Возвращает

boolean
Успех.

Реализация

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

read()source public

read( string $key )

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

Параметры

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

Возвращает

array
Обработанные значения конфигурации.

Исключения

Cake\Core\Exception\Exception

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

Реализация

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

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

_getFilePath()source protected

_getFilePath( string $key , boolean $checkExists false )

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

Параметры

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

Возвращает

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

Исключения

Cake\Core\Exception\Exception

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

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

$_extensionsource

protected string

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

'.ini'

$_sectionsource

protected string|null

Раздел для чтения, если null, будут прочитаны все разделы.

© 2005–2017 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.4/class-Cake.Core.Configure.Engine.IniConfig.html