Класс JsonConfig
Движок JSON позволяет Configure загружать значения конфигурации из файлов, содержащих строки JSON.
Пример файла JSON:
{
"debug": false,
"App": {
"namespace": "MyApp"
},
"Security": {
"salt": "its-secret"
}
} Краткое описание свойств
- $_extension protected
stringРасширение файла.
- $_path protected
stringПуть, по которому движок находит файлы.
Краткое описание методов
-
__construct() public
Конструктор для чтения файла конфигурации JSON.
-
_getFilePath() protected
Получить путь к файлу
-
dump() public
Преобразует предоставленные данные $data в строку JSON, которую можно сохранить в файл и загрузить позже.
-
read() public
Чтение файла конфигурации и возвращение его содержимого.
Подробное описание методов
__construct() public
__construct(string|null $path = null)
Конструктор для чтения файла конфигурации JSON.
Параметры
-
string|null$path optional Путь для чтения файлов конфигурации. По умолчанию CONFIG.
_getFilePath() protected
_getFilePath(string $key, bool $checkExists = false): string
Получить путь к файлу
Параметры
-
string$key Идентификатор для записи. Если ключ содержит ., он будет обработан как префикс плагина.
-
bool$checkExists optional Флаг проверки существования файла. По умолчанию false.
Возвращает
stringИсключения
Cake\Core\Exception\CakeExceptionПри отсутствии файлов или если файлы содержат '..', что может привести к злоупотреблению чтением.
dump() public
dump(string $key, array $data): bool
Преобразует предоставленные данные $data в строку JSON, которую можно сохранить в файл и загрузить позже.
Параметры
-
string$key Идентификатор для записи. Если ключ содержит ., он будет обработан как префикс плагина.
-
array$data Данные для преобразования.
Возвращает
boolread() public
read(string $key): array
Чтение файла конфигурации и возвращение его содержимого.
Файлы с . в имени будут обрабатываться как значения в плагинах. Вместо чтения из заданного пути, ключи плагинов будут найдены с помощью Plugin::path().
Параметры
-
string$key Идентификатор для чтения. Если ключ содержит ., он будет обработан как префикс плагина.
Возвращает
arrayИсключения
Cake\Core\Exception\CakeExceptionПри отсутствии файлов, если файлы содержат '..' (что может привести к злоупотреблению чтением), или при ошибке парсинга строки JSON.
Подробное описание свойств
$_extension protected
Расширение файла.
Тип
string$_path protected
Путь, по которому движок находит файлы.
Тип
string
© 2005–present 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/4.4/class-Cake.Core.Configure.Engine.JsonConfig.html
