kyos/configparser

一个简单的 YAML 配置文件加载器。

3.0.0 2022-03-27 17:24 UTC

This package is auto-updated.

Last update: 2024-08-27 22:43:57 UTC


README

banner

configparser

Latest Version on Packagist Software License CI Coverage Status Total Downloads

一个简单的 YAML 配置文件加载器。

安装

通过 Composer

$ composer require kyos/configparser

用法

给定以下 config.yaml 配置文件

application:
  releaseStage: Production
  debugMode: true

您可以使用以下方式解析其任何属性

$parser = Kyos\ConfigParser::getParserForFile('config.yaml');
echo $parser->get('application.releaseStage');

您可以使用以下表示法

  1. 点表示法:
echo $parser->get('application.releaseStage');
  1. 数组表示法:
echo $parser->get(['application', 'releaseStage']);
  1. 字符串表示法(用于顶级键)
var_dump($parser->get('application'));

断言

使用 ConfigParser,您可以要求特定的键被定义以及它们的类型。注意:所有命令都应该由一个评估函数调用 precede。

所需键

echo $parser->evaluate('application.releaseStage')->isRequired();

字符串

echo $parser->evaluate('application.releaseStage')->isString();

数字

echo $parser->evaluate('application.releaseStage')->isNumeric();

布尔值

echo $parser->evaluate('application.releaseStage')->isBoolean();

数组

echo $parser->evaluate('application')->isArray();

允许的值

echo $parser->evaluate('application.releaseStage')->isOneOf(['Production', 'Staging', 'Test']);

断言函数也可以链式调用。

echo $parser->evaluate('application.releaseStage')
            ->isRequired()->isString()
            ->isOneOf(['Production', 'Staging', 'Test']);

变更日志

请参阅 变更日志 以获取有关最近更改的更多信息。

测试

$ composer test

安全性

如果您发现任何与安全相关的问题,请通过电子邮件 pagoulatos@kyos.com 而不是使用问题跟踪器。

致谢

许可

MIT 许可证(MIT)。有关更多信息,请参阅 许可文件