CakePHP
  • 文档
    • 书籍
    • API
    • 视频
    • 报告安全问题
    • 隐私政策
    • 徽标和商标
  • 商业解决方案
  • 周边产品
  • 公路旅行
  • 团队
  • 社区
    • 社区
    • 参与进来
    • 问题 (Github)
    • 烘焙坊
    • 精选资源
    • 培训
    • 聚会
    • 我的 CakePHP
    • CakeFest
    • 通讯
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • 帮助和支持
    • 论坛
    • Stack Overflow
    • IRC
    • Slack
    • 付费支持
CakePHP

C CakePHP 5.1 Chiffon API

  • 项目
    • CakePHP
      • CakePHP
      • Chronos
      • Elastic Search
      • 队列
  • 版本
    • 5.1
      • 5.1
      • 5.0
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

命名空间

  • 全局
  • Cake
    • 缓存
    • 集合
    • 命令
    • 控制台
    • 控制器
    • 核心
      • 配置
        • 引擎
      • 异常
      • 重试
      • 测试套件
    • 数据库
    • 数据源
    • 错误
    • 事件
    • 表单
    • HTTP
    • 国际化
    • 日志
    • 邮件
    • 网络
    • ORM
    • 路由
    • 测试套件
    • 工具
    • 验证
    • 视图

类 IniConfig

Ini 文件配置引擎。

由于 IniConfig 在底层使用 parse_ini_file,您应该注意此类共享相同的行为,尤其是关于布尔值和空值的行为。

除了本机 parse_ini_file 功能之外,IniConfig 还允许您通过使用 . 分隔的名称来创建嵌套数组结构。这使您能够在 ini 配置文件中创建嵌套数组结构。例如

db.password = secret 将变成 ['db' => ['password' => 'secret']]

您可以使用 . 尽可能深入地嵌套属性。除了使用 . 之外,您还可以使用标准的 ini 部分符号来创建嵌套结构

[section]
key = value

加载到 Configure 后,上述内容将使用以下方法访问

`Configure::read('section.key');

您还可以使用 . 分隔的值在部分名称中创建更深入的嵌套结构。

IniConfig 还操作如何处理 'yes'、'no'、'on'、'off'、'null' 这些特殊的 ini 值。这些值将转换为其布尔等效项。

命名空间: Cake\Core\Configure\Engine
参见: https://secure.php.net/parse_ini_file

属性摘要

  • $_extension protected
    string

    文件扩展名。

  • $_path protected
    string

    此引擎在其中查找文件的路径。

  • $_section protected
    string|null

    要读取的部分,如果为 null,将读取所有部分。

方法摘要

  • __construct() public

    构建并构造一个新的 ini 文件解析器。解析器可用于读取文件系统上的 ini 文件。

  • _getFilePath() protected

    获取文件路径

  • _parseNestedValues() protected

    从键中解析嵌套的值。

  • _value() protected

    将值转换为 ini 等效值

  • dump() public

    将 Configure 数据的状态转储到格式化的 ini 字符串中。

  • read() public

    读取 ini 文件并将结果作为数组返回。

方法详情

__construct() ¶ public

__construct(string|null $path = null, string|null $section = null)

构建并构造一个新的 ini 文件解析器。解析器可用于读取文件系统上的 ini 文件。

参数
string|null $path optional

要从中加载 ini 配置文件的路径。默认为 CONFIG。

string|null $section optional

仅获取一个部分,保留 null 以解析并获取 ini 文件中的所有部分。

_getFilePath() ¶ protected

_getFilePath(string $key, bool $checkExists = false): string

获取文件路径

参数
string $key

要写入的标识符。如果键包含 .,它将被视为插件前缀。

bool $checkExists optional

是否检查文件是否存在。默认为 false。

返回值
string
抛出
Cake\Core\Exception\CakeException
当文件不存在或文件包含 '..' 时,因为这会导致恶意读取。

_parseNestedValues() ¶ protected

_parseNestedValues(array $values): array

从键中解析嵌套的值。

参数
array $values

要分解的值。

返回值
array

_value() ¶ protected

_value(mixed $value): string

将值转换为 ini 等效值

参数
mixed $value

要导出的值。

返回值
string

dump() ¶ public

dump(string $key, array $data): bool

将 Configure 数据的状态转储到格式化的 ini 字符串中。

参数
string $key

要写入的标识符。如果键包含 .,它将被视为插件前缀。

array $data

要转换为 ini 文件的数据。

返回值
bool

read() ¶ public

read(string $key): array

读取 ini 文件并将结果作为数组返回。

此方法用于从源读取配置信息。这些源可以是静态资源(如文件),也可以是动态资源(如数据库或其他数据源)。

参数
string $key

要从中读取的标识符。如果键包含 .,它将被视为插件前缀。所选文件必须位于引擎的路径上。

返回值
array
抛出
Cake\Core\Exception\CakeException
当文件不存在时。或者当文件包含 '..' 时,因为这会导致恶意读取。

属性详情

$_extension ¶ protected

文件扩展名。

类型
string

$_path ¶ protected

此引擎在其中查找文件的路径。

类型
string

$_section ¶ protected

要读取的部分,如果为 null,将读取所有部分。

类型
string|null
OpenHub
Pingping
Linode
  • 商业解决方案
  • 展示
  • 文档
  • 书籍
  • API
  • 视频
  • 报告安全问题
  • 隐私政策
  • 徽标和商标
  • 社区
  • 参与进来
  • 问题 (Github)
  • 烘焙坊
  • 精选资源
  • 培训
  • 聚会
  • 我的 CakePHP
  • CakeFest
  • 通讯
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • 帮助和支持
  • 论坛
  • Stack Overflow
  • IRC
  • Slack
  • 付费支持

使用 CakePHP API 文档 生成