README

配置文件辅助工具，用于读取不同文件格式。

• 命名空间: Mireiawen\Configuration

需求

• PHP 7.3 或更高版本
• 根据所需文件类型所需的扩展
  • JSON
  • YAML

安装

您可以从GitHub 仓库克隆或下载代码，或者您可以使用 composer: composer require mireiawen/configuration

示例

$configuration = new Mireiawen\Configuration\JSON('config.json');
$hostname = $configuration->GetString('hostname');
$port = $configuration->GetInt('port');

JSON 特定方法

__construct

JSON 类构造函数

Configuration::__construct(string $filename)

参数

抛出的异常

YAML 特定方法

__construct

YAML 类构造函数

Configuration::__construct(string $filename)

参数

抛出的异常

公共接口方法

• Has
• Get
• GetString
• GetInt
• GetFloat
• GetBool
• GetAsString
• GetAsInt
• GetAsFloat
• GetAsBool

Has

检查配置变量是否存在并且已设置。

Configuration::Has(string $key) : bool

参数

返回值

Get

获取配置变量并返回其值，如果未设置则返回默认值。

Configuration::Get(string $key, mixed $default) : mixed

参数

返回值

抛出的异常

GetString

获取配置变量并返回其值，如果未设置则返回默认值，并进行类型验证。

Configuration::GetString(string $key, string|null $default) : string

参数

返回值

抛出的异常

GetInt

获取配置变量并返回其值，如果未设置则返回默认值，并进行类型验证。

Configuration::GetInt(string $key, int|null $default) : int

参数

返回值

抛出的异常

GetFloat

获取配置变量并返回其值，如果未设置则返回默认值，并进行类型验证。

Configuration::GetFloat(string $key, float|null $default) : float

参数

返回值

抛出的异常

GetBool

获取配置变量并返回其值，如果未设置则返回默认值，并进行类型验证。

Configuration::GetBool(string $key, bool|null $default) : bool

参数

返回值

抛出的异常

GetAsString

获取配置变量并返回其值，如果未设置则返回默认值，并将返回值强制转换为正确的类型。

Configuration::GetAsString(string $key, string|null $default) : string

参数

返回值

抛出的异常

GetAsInt

获取配置变量并返回其值，如果未设置则返回默认值，并将返回值强制转换为正确的类型。

Configuration::GetAsInt(string $key, int|null $default) : int

参数

返回值

抛出的异常

GetAsFloat

获取配置变量并返回其值，如果未设置则返回默认值，并将返回值强制转换为正确的类型。

Configuration::GetAsFloat(string $key, float|null $default) : float

参数

返回值

抛出的异常

GetAsBool

获取配置变量并返回其值，如果未设置则返回默认值，并将返回值强制转换为正确的类型。

Configuration::GetAsBool(string key, bool|null default) : bool

参数

返回值

抛出的异常