类 PhpConfig
PHP 引擎允许 Configure 从包含简单 PHP 数组的文件加载配置值。
与 PhpConfig 兼容的文件应返回一个数组,其中包含文件中包含的所有配置数据。
一个示例配置文件如下所示:
<?php
return [
'debug' => false,
'Security' => [
'salt' => 'its-secret'
],
'App' => [
'namespace' => 'App'
]
];
属性概要
-
$_extension protected
字符串
文件扩展名。
-
$_path protected
字符串
此引擎在其中查找文件的路径。
方法概要
-
__construct() public
用于 PHP 配置文件读取的构造函数。
-
_getFilePath() protected
获取文件路径
-
dump() public
将提供的 $data 转换为可以保存到文件中并稍后加载的 PHP 代码字符串。
-
read() public
读取配置文件并返回其内容。
方法详细信息
__construct() ¶ public
__construct(string|null $path = null)
用于 PHP 配置文件读取的构造函数。
参数
-
string|null
$path 可选 要从中读取配置文件的路径。默认值为 CONFIG。
_getFilePath() ¶ protected
_getFilePath(string $key, bool $checkExists = false): string
获取文件路径
参数
-
string
$key 要写入的标识符。如果键包含 .,它将被视为插件前缀。
-
bool
$checkExists 可选 是否检查文件是否存在。默认为 false。
返回值
字符串
抛出
Cake\Core\Exception\CakeException
当文件不存在或文件包含 '..' 时,因为这可能导致滥用读取。
dump() ¶ public
dump(string $key, array $data): bool
将提供的 $data 转换为可以保存到文件中并稍后加载的 PHP 代码字符串。
参数
-
string
$key 要写入的标识符。如果键包含 .,它将被视为插件前缀。
-
array
$data 要转储的数据。
返回值
布尔值
read() ¶ public
read(string $key): array
读取配置文件并返回其内容。
名称中包含 .
的文件将被视为插件中的值。插件键将使用 Plugin::path() 查找,而不是从初始化的路径读取。
参数
-
string
$key 要从中读取的标识符。如果键包含 .,它将被视为插件前缀。
返回值
数组
抛出
Cake\Core\Exception\CakeException
当文件不存在或文件不包含 `$config` 时。或者当文件包含 '..' 时,因为这可能导致滥用读取。