Spec-Zone.ru › CakePHP 2.10

Класс 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
Пакет: Cake\Configure
См.: http://php.net/parse_ini_file
Авторские права: Авторские права (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/Configure/IniReader.php

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

  • $_path protected
    array
    Путь для чтения файлов ini.
  • $_section protected
    string
    Раздел для чтения, если null, будут считаны все разделы.

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

  • __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()

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

$_pathsource

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/2.10/class-IniReader.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API