Класс JsonConfig
Двигатель JSON позволяет Configure загружать значения конфигурации из файлов, содержащих строки JSON.
Пример файла JSON будет выглядеть следующим образом::
{
"debug": false,
"App": {
"namespace": "MyApp"
},
"Security": {
"salt": "its-secret"
}
} - 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
$pathнеобязательно 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 Идентификатор для чтения. Если ключ содержит ., он будет обрабатываться как префикс плагина.
Возвращает
массивОбработанные значения конфигурации.
Выбрасывает
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
$checkExistsнеобязательно false - Требовать проверку наличия файла. По умолчанию false.
Возвращает
строкаПолный путь к файлу
Выбрасывает
Cake\Core\Exception\ExceptionКогда файлы не существуют или когда файлы содержат '..', так как это может привести к злоупотреблению чтением.
Подробное описание свойств
© 2005–2018 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.5/class-Cake.Core.Configure.Engine.JsonConfig.html