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

Параметры

string|null $path optional null: Путь для загрузки файлов конфигурации ini. По умолчанию CONFIG.
string|null $section optional 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 optional false: Флаг проверки существования файла. По умолчанию false.

Возвращает

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

Использует

Cake\Core\Exception\Exception

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

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

$_extensionsource

protected string

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

'.ini'

$_sectionsource

protected string

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

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Core.Configure.Engine.IniConfig.html