Spec-Zone.ru › CakePHP 3.6

Класс 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

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

Возвращает

массив
Обработанные значения конфигурации.

Выбрасывает

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

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


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

$_extensionsource

protected строка

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

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

Spec-Zone.ru

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