Класс IniConfig

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

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

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

db.password = secret преобразуется в ['db' => ['password' => 'secret']]

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

[section]
key = value

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

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

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

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

Cake\Core\Configure\Engine\IniConfig реализует Cake\Core\Configure\ConfigEngineInterface использует Cake\Core\Configure\FileConfigTrait

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

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

$_extension protected

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

string
Секция для чтения, если 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.

Возвращает

boolean
Успех.

Реализация

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: Идентификатор для записи. Если ключ содержит ., он будет интерпретироваться как префикс плагина.
boolean $checkExists необязательно false: Нужно ли проверять, существует ли файл. По умолчанию false.

Возвращает

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

Исключения

Cake\Core\Exception\Exception

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

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

$_extensionsource

protected строка

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

'.ini'

$_sectionsource

protected строка

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