Spec-Zone.ru › CakePHP 2.10

Класс PhpReader

PHP Reader позволяет Configure загружать значения конфигурации из файлов, содержащих простые PHP массивы.

Файлы, совместимые с PhpReader, должны определять переменную $config, которая содержит все данные конфигурации, содержащиеся в файле.

PhpReader реализует ConfigReaderInterface
Пакет: Cake\Configure
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Configure/PhpReader.php

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

  • $_path protected
    string
    Путь, по которому этот читатель находит файлы.

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

  • __construct() public
    Конструктор для чтения файла конфигурации PHP.
  • _getFilePath() protected
    Получить путь к файлу
  • dump() public

    Преобразует предоставленные $data в строку PHP-кода, которую можно сохранить в файл и загрузить позже.

  • read() public
    Прочитать файл конфигурации и вернуть его содержимое.

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

__construct()source public

__construct( string $path null )

Конструктор для чтения файла конфигурации PHP.

Параметры

string $path необязательный null
Путь для чтения файлов конфигурации. По умолчанию CONFIG

_getFilePath()source protected

_getFilePath( string $key )

Получить путь к файлу

Параметры

string $key

Идентификатор, к которому нужно записать. Если ключ содержит ., он будет обрабатываться как префикс плагина.

Возвращает

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

dump()source public

dump( string $key , array $data )

Преобразует предоставленные $data в строку PHP-кода, которую можно сохранить в файл и загрузить позже.

Параметры

string $key

Идентификатор, к которому нужно записать. Если ключ содержит ., он будет обрабатываться как префикс плагина.

array $data
Данные для выгрузки.

Возвращает

integer
Сохраненные байты.

Реализация

ConfigReaderInterface::dump()

read()source public

read( string $key )

Прочитать файл конфигурации и вернуть его содержимое.

Файлы с . в имени будут обрабатываться как значения плагинов. Вместо чтения из инициализированного пути, ключи плагинов будут находиться с помощью CakePlugin::path().

Параметры

string $key

Идентификатор для чтения. Если ключ содержит ., он будет обрабатываться как префикс плагина.

Возвращает

array
Разложенные значения конфигурации.

Вызывает

ConfigureException

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


Реализация

ConfigReaderInterface::read()

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

$_pathsource

protected string

Путь, по которому этот читатель находит файлы.

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-PhpReader.html

Spec-Zone.ru

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