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