Класс IniReader
Двигатель конфигурации файла INI.
Поскольку IniReader использует parse_ini_file внизу, вы должны знать, что этот класс имеет такое же поведение, особенно в отношении логических и нулевых значений.
В дополнение к родным parse_ini_file функциям, IniReader также позволяет создавать вложенные массивы структур с помощью разделителей . в именах. Это позволяет создавать вложенные структуры массивов в файле конфигурации ini. Например:
db.password = secret превратится в array('db' => array('password' => 'secret'))
Вы можете вкладывать свойства так глубоко, как вам нужно, используя .. В дополнение к использованию . вы можете использовать стандартную нотацию раздела ini для создания вложенных структур:
[section] key = value
После загрузки в Configure, вышеуказанное будет доступно с помощью:
`Configure::read('section.key');
Вы можете комбинировать значения, разделенные . , с разделами, чтобы создать более глубоко вложенные структуры.
IniReader также управляет обработкой специальных значений ini 'yes', 'no', 'on', 'off', 'null'. Эти значения будут преобразованы в их логические эквиваленты.
- IniReader реализует ConfigReaderInterface
См.: http://php.net/parse_ini_file
Авторские права: Авторские права (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/Configure/IniReader.php
Краткое описание свойств
-
$_pathprotectedПуть для чтения файлов ini.array -
$_sectionprotectedРаздел для чтения, если null, будут считаны все разделы.string
Краткое описание методов
- __construct() public
Создает и инициализирует новый парсер файлов ini. Парсер может использоваться для чтения файлов ini, находящихся в файловой системе.
- _getFilePath() protectedПолучение пути к файлу
- _parseNestedValues() protectedПарсинг вложенных значений из ключей.
- _value() protectedПреобразование значения в эквивалент ini
- dump() publicВывод состояния данных Configure в строку формата ini.
- read() publicЧтение файла ini и возврат результатов в виде массива.
Подробное описание методов
__construct()source public
__construct( string $path null , string $section null )
Создает и инициализирует новый парсер файлов ini. Парсер может использоваться для чтения файлов ini, находящихся в файловой системе.
Параметры
- строка
$pathнеобязательный null - Путь для загрузки файлов конфигурации ini. По умолчанию CONFIG
- строка
$sectionнеобязательный null Получить только один раздел, оставить null, чтобы разобрать и получить все разделы в файле ini.
_getFilePath()source protected
_getFilePath( string $key )
Получение пути к файлу
Параметры
- строка
$key Идентификатор для записи. Если ключ содержит ., он будет обрабатываться как префикс плагина.
Возвращает
строкаПолный путь к файлу
_parseNestedValues()source protected
_parseNestedValues( array $values )
Парсинг вложенных значений из ключей.
Параметры
- массив
$values - Значения для разбиения.
Возвращает
массивМассив разделенных значений
_value()source protected
_value( mixed $val )
Преобразование значения в эквивалент ini
Параметры
- смешанный
$val - Значение для экспорта.
Возвращает
строкаСтроковое значение для файла ini.
dump()source public
dump( string $key , array $data )
Вывод состояния данных Configure в строку формата ini.
Параметры
- строка
$key Идентификатор для записи. Если ключ содержит ., он будет обрабатываться как префикс плагина.
- массив
$data - Данные для преобразования в ini-файл.
Возвращает
целое числоСохраненные байты.
Реализация
ConfigReaderInterface::dump() read()source public
read( string $key )
Чтение файла ini и возврат результатов в виде массива.
Для обратной совместимости, acl.ini.php будет обрабатываться особым образом до версии 3.0.
Параметры
- строка
$key Идентификатор для чтения. Если ключ содержит ., он будет обрабатываться как префикс плагина. Выбранный файл должен находиться в пути к читателю.
Возвращает
массивОбработанные значения конфигурации.
Исключения
ConfigureExceptionесли файлы не существуют. Или если файлы содержат '..', так как это может привести к злоупотреблению чтением.
Реализация
ConfigReaderInterface::read() Подробное описание свойств
© 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/2.10/class-IniReader.html