Spec-Zone.ru › CakePHP 3.8

Класс 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
Пространство имён: Cake\Core\Configure\Engine
Расположение: Core/Configure/Engine/JsonConfig.php

Краткое описание свойств

  • $_extension protected
    string
    Расширение файла.

Унаследованные свойства

  • _path

Краткое описание методов

  • __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

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

Возвращает

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 $checkExists необязательный false
Нужно ли проверять существование файла. По умолчанию false.

Возвращает

string
Полный путь к файлу

Исключения

Cake\Core\Exception\Exception

Когда файлы не существуют или когда файлы содержат '..', что может привести к злоупотреблению чтением.


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

$_extensionsource

protected string

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

'.json'

© 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/3.8/class-Cake.Core.Configure.Engine.JsonConfig.html

Spec-Zone.ru

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