Spec-Zone.ru › CakePHP 3.1

Класс JsonConfig

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

Cake\Core\Configure\Engine\JsonConfig реализует Cake\Core\Configure\ConfigEngineInterface и использует Cake\Core\Configure\FileConfigTrait
Пространство имён: Cake\Core\Configure\Engine
Расположение: Core/Configure/Engine/JsonConfig.php

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

__constructsource public

__construct( string|null $path null )

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

Параметры

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

dumpsource public

dump( string $key , array $data )

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

Параметры

string $key
Идентификатор для записи. Если ключ содержит точку, он будет интерпретироваться как префикс плагина.
array $data
Данные для сохранения.

Возвращает

boolean
Успех

Реализация

Cake\Core\Configure\ConfigEngineInterface::dump()

readsource public

read( string $key )

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

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

Параметры

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

Возвращает

array
Обработанные значения конфигурации.

Исключение

Cake\Core\Exception\Exception
Если файлы не существуют, или файлы содержат '..' (что может привести к злоупотреблению чтением), или при ошибке обработки строки JSON.

Реализация

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
Если файлы не существуют, или файлы содержат '..' (что может привести к злоупотреблению чтением).

Сводка свойств

$_extensionsource

protected string

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

'.json'

Свойства, используемые из Cake\Core\Configure\FileConfigTrait

$_pathsource

protected string

Путь к файлам, используемый этим движком.

''

© 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.JsonConfig.html

Spec-Zone.ru

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