Класс PhpConfig

Двигатель PHP позволяет Configure загружать значения конфигурации из файлов, содержащих простые массивы PHP.

Файлы, совместимые с PhpConfig, должны возвращать массив, содержащий все данные конфигурации, содержащиеся в файле.

Пример файла конфигурации:

<?php
return [
    'debug' => 0,
    'Security' => [
        'salt' => 'its-secret'
    ],
    'App' => [
        'namespace' => 'App'
    ]
];

Cake\Core\Configure\Engine\PhpConfig реализует Cake\Core\Configure\ConfigEngineInterface использует Cake\Core\Configure\FileConfigTrait

Пространство имён: Cake\Core\Configure\Engine
См.: Cake\Core\Configure::load() для загрузки пользовательских файлов конфигурации.
Расположение: Core/Configure/Engine/PhpConfig.php

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

$_extension protected

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

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

_path

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

__construct() public
Конструктор для чтения файла конфигурации PHP.
dump() public

Преобразует предоставленные $data в строку кода PHP, которая может быть сохранена в файл и загружена позже.
read() public
Чтение файла конфигурации и возвращение его содержимого.

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

__construct()source public

__construct( string|null $path = null )

Конструктор для чтения файла конфигурации PHP.

Параметры

string|null $path необязательный null: Путь для чтения файлов конфигурации. По умолчанию CONFIG.

dump()source public

dump( string $key , array $data )

Преобразует предоставленные $data в строку кода PHP, которая может быть сохранена в файл и загружена позже.

Параметры

string $key: Идентификатор для записи. Если ключ содержит ., он будет обрабатываться как префикс плагина.
array $data: Данные для дампинга.

Возвращает

boolean
Успех

Реализация

Cake\Core\Configure\ConfigEngineInterface::dump()

read()source public

read( string $key )

Чтение файла конфигурации и возвращение его содержимого.

Файлы с . в имени будут обрабатываться как значения в плагинах. Вместо чтения из инициализированного пути, ключи плагина будут находиться с помощью Plugin::path().

Установка переменной $config устарела. Используйте return вместо этого.

Параметры

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

Возвращает

массив
Разбор значений конфигурации.

Выбрасывает

Cake\Core\Exception\Exception

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

Реализация

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 строка

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

'.php'

© 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.PhpConfig.html