Класс JsonConfig
Двигатель JSON позволяет Configure загружать значения конфигурации из файлов, содержащих строки JSON.
- Cake\Core\Configure\Engine\JsonConfig реализует Cake\Core\Configure\ConfigEngineInterface использует Cake\Core\Configure\FileConfigTrait
Краткое описание свойств
-
$_extensionprotectedРасширение файла.string
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор для чтения файла конфигурации JSON.
- dump() public
Преобразует предоставленные данные $data в строку JSON, которая может быть сохранена в файл и загружена позже.
- read() publicЧтение файла конфигурации и возвращение его содержимого.
Подробное описание методов
__construct()source public
__construct( string|null $path null )
Конструктор для чтения файла конфигурации JSON.
Параметры
- string|null
$pathoptional null - Путь для чтения файлов конфигурации. По умолчанию CONFIG.
dump()source public
dump( string $key , array $data )
Преобразует предоставленные данные $data в строку JSON, которая может быть сохранена в файл и загружена позже.
Параметры
- string
$key Идентификатор для записи. Если ключ содержит ., он будет интерпретироваться как префикс плагина.
- array
$data - Данные для записи.
Возвращаемое значение
booleanУспех
Реализация
Cake\Core\Configure\ConfigEngineInterface::dump() read()source public
read( string $key )
Чтение файла конфигурации и возвращение его содержимого.
Файлы с . в имени будут обрабатываться как значения в плагинах. Вместо чтения из заданного пути, ключи плагинов будут находиться с помощью Plugin::path().
Параметры
- string
$key Идентификатор для чтения. Если ключ содержит ., он будет интерпретироваться как префикс плагина.
Возвращаемое значение
arrayОбработанные значения конфигурации.
Исключения
Cake\Core\Exception\ExceptionЕсли файлы не существуют, содержат '..' (что может привести к злоупотреблению чтением), или возникла ошибка при разборе строки JSON.
Реализация
Cake\Core\Configure\ConfigEngineInterface::read() Методы, используемые из Cake\Core\Configure\FileConfigTrait
_getFilePath()source protected
_getFilePath( string $key , boolean $checkExists false )
Получение пути к файлу
Параметры
- string
$key Идентификатор для записи. Если ключ содержит ., он будет интерпретироваться как префикс плагина.
- boolean
$checkExistsoptional false - Флаг, указывающий на необходимость проверки существования файла. По умолчанию false.
Возвращаемое значение
stringПолный путь к файлу
Исключения
Cake\Core\Exception\ExceptionЕсли файлы не существуют или содержат '..' (что может привести к злоупотреблению чтением).
Подробное описание свойств
© 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.2/class-Cake.Core.Configure.Engine.JsonConfig.html