Класс PhpConfig
Двигатель PHP позволяет Configure загружать значения конфигурации из файлов, содержащих простые массивы PHP.
Файлы, совместимые с PhpConfig, должны возвращать массив, содержащий все данные конфигурации, содержащиеся в файле.
Пример файла конфигурации:
<?php
return [
'debug' => false,
'Security' => [
'salt' => 'its-secret'
],
'App' => [
'namespace' => 'App'
]
]; См.: \Cake\Core\Configure::load() для загрузки пользовательских файлов конфигурации.
Краткое описание свойств
- $_extension защищённый
stringРасширение файла.
- $_path защищённый
stringПуть, по которому этот движок находит файлы.
Краткое описание методов
-
__construct() публичный
Конструктор для чтения файла конфигурации PHP.
-
_getFilePath() защищённый
Получить путь к файлу
-
dump() публичный
Преобразует предоставленные данные $data в строку кода PHP, которая может быть сохранена в файле и загружена позже.
-
read() публичный
Прочитать файл конфигурации и вернуть его содержимое.
Подробное описание методов
__construct() публичный
__construct(string|null $path = null)
Конструктор для чтения файла конфигурации PHP.
Параметры
-
string|null$path необязательный Путь для чтения файлов конфигурации. По умолчанию CONFIG.
_getFilePath() защищённый
_getFilePath(string $key, bool $checkExists = false): string
Получить путь к файлу
Параметры
-
string$key Идентификатор для записи. Если ключ содержит точку, он будет обрабатываться как префикс плагина.
-
bool$checkExists необязательный Выполнять ли проверку существования файла. По умолчанию false.
Возвращает
stringИсключения
Cake\Core\Exception\CakeExceptionПри отсутствии файлов или при наличии '..' в файлах, что может привести к злоупотреблению чтением.
dump() публичный
dump(string $key, array $data): bool
Преобразует предоставленные данные $data в строку кода PHP, которая может быть сохранена в файле и загружена позже.
Параметры
-
string$key Идентификатор для записи. Если ключ содержит точку, он будет обрабатываться как префикс плагина.
-
array$data Данные для выгрузки.
Возвращает
boolread() публичный
read(string $key): array
Прочитать файл конфигурации и вернуть его содержимое.
Файлы с . в имени будут обрабатываться как значения в плагинах. Вместо чтения из инициализированного пути, ключи плагинов будут найдены с помощью Plugin::path().
Параметры
-
string$key Идентификатор для чтения. Если ключ содержит точку, он будет обрабатываться как префикс плагина.
Возвращает
arrayИсключения
Cake\Core\Exception\CakeExceptionпри отсутствии файлов, при отсутствии `$config` в файлах или при наличии '..' в файлах, что может привести к злоупотреблению чтением.
Подробное описание свойств
$_extension защищённый
Расширение файла.
Тип
string$_path защищённый
Путь, по которому этот движок находит файлы.
Тип
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.2/class-Cake.Core.Configure.Engine.PhpConfig.html
