Класс 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
См.: http://php.net/parse_ini_file
Расположение: Core/Configure/Engine/IniConfig.php
Подробное описание методов
__constructsource public
__construct( string|null $path null , string|null $section null )
Создаёт и инициализирует новый парсер файлов ini. Парсер может использоваться для чтения файлов ini, расположенных в файловой системе.
Параметры
- string|null
$pathнеобязательный null - Путь к файлам конфигурации ini для загрузки. По умолчанию CONFIG.
- string|null
$sectionнеобязательный null - Получить только один раздел. Если оставить null, будут обработаны и получены все разделы в файле ini.
_parseNestedValuessource protected
_parseNestedValues( array $values )
Обрабатывает вложенные значения из ключей.
Параметры
- array
$values - Значения для разделения.
Возвращает
arrayМассив разделенных значений
_valuesource protected
_value( mixed $value )
Преобразует значение в эквивалент ini.
Параметры
- mixed
$value - Значение для экспорта.
Возвращает
stringСтроковое значение для файла ini.
dumpsource public
dump( string $key , array $data )
Выводит состояние данных Configure в строку с форматированием ini.
Параметры
- string
$key - Идентификатор для записи. Если ключ содержит ".", он будет обрабатываться как префикс плагина.
- array
$data - Данные для преобразования в ini-файл.
Возвращает
booleanУспех.
Реализация
Cake\Core\Configure\ConfigEngineInterface::dump() readsource public
read( string $key )
Читает файл ini и возвращает результаты в виде массива.
Параметры
- string
$key - Идентификатор для чтения. Если ключ содержит ".", он будет обрабатываться как префикс плагина. Выбранный файл должен быть в пути к движку.
Возвращает
arrayОбработанные значения конфигурации.
Вызывает исключение
Cake\Core\Exception\Exceptionв случае, если файлы не существуют. Или если файлы содержат '..', так как это может привести к злоупотреблению чтением.
Реализация
Cake\Core\Configure\ConfigEngineInterface::read() Методы, используемые из Cake\Core\Configure\FileConfigTrait
_getFilePathsource protected
_getFilePath( string $key , boolean $checkExists false )
Получить путь к файлу
Параметры
- string
$key - Идентификатор для записи. Если ключ содержит ".", он будет обрабатываться как префикс плагина.
- boolean
$checkExistsнеобязательный false - Флаг, указывающий на необходимость проверки существования файла. По умолчанию false.
Возвращает
stringПолный путь к файлу
Вызывает исключение
Cake\Core\Exception\ExceptionЕсли файлы не существуют или содержат '..' (что может привести к злоупотреблению чтением).
Резюме свойств
Свойства, используемые из Cake\Core\Configure\FileConfigTrait
© 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.1/class-Cake.Core.Configure.Engine.IniConfig.html