flavioheleno/env

轻松处理环境变量。

维护者

详细信息

github.com/flavioheleno/env

主页

源代码

问题

资助包维护！
Patreon

安装: 116

依赖: 0

建议者: 0

安全性: 0

星标: 2

观察者: 3

分支: 0

公开问题: 3

v0.3 2021-01-07 01:51 UTC

Requires

  • php: >=7.3

Requires (Dev)

mit 7d1da9e5018c5dfa5f0839bdbe980bb79294a9e1

  • Flavio Heleno <flaviohbatista.woop@gmail.com>

environmentenvenvironment variableenv varenvvarenv variable

This package is auto-updated.

Last update: 2024-08-24 23:58:05 UTC

README

轻松处理环境变量。

使用 composer 安装

composer require flavioheleno/env

读或必需？

此库包含两个辅助函数

  • Env\Read，它将尝试读取一个变量并返回其值，如果变量未设置，则回退到 $default 值；
  • Env\Required，它将尝试读取一个变量并返回其值，如果变量未设置，则抛出异常。

用法

您可以使用以下方式 读取 环境变量

$value = Env\Read::asString('my_var', 'default_value');

另一方面，您可以使用以下方式 要求 环境变量

try {
  $value = Env\Required::asString('my_var');
} catch (RuntimeException $exception) {
  // handle exception
}

不可变环境

库在第一次方法调用时将环境变量加载到内部副本。

如果您需要更新内部副本，可以使用以下方式

Env\Read::updateEnv();

或

Env\Required::updateEnv();

可用方法

以下所有方法都可在 Env\Read 和 Env\Required 辅助函数中使用。

  • updateEnv：更新内部环境变量副本；
  • asString：以字符串形式返回值；
  • asArray：以数组形式返回值（以逗号分隔）；
  • asInteger：以整数形式返回值；
  • asFloat：以浮点数形式返回值；
  • asBool：以布尔值形式返回值；
  • fromJson：以 JSON 解码的值/对象返回值；
  • fromSerialized：以反序列化的值/对象返回值。

贡献

有一些辅助脚本可以通过 composer 调用，例如

  • 静态代码分析： php composer.phar run check
  • 代码检查： php composer.phar run lint
  • 测试： php composer.phar run test

注意：要运行 代码检查，您必须首先从 此处 下载规则集。

许可证

此库根据 MIT 许可证 许可。