quillstack/dotenv

用于使用 .env 文件的库。

v0.0.6 2022-01-14 10:07 UTC

This package is auto-updated.

Last update: 2024-09-14 16:03:22 UTC


README

Build Status Downloads Coverage Lines of Code StyleCI CodeFactor Packagist License Reliability Rating Maintainability Security Rating Packagist PHP Version Support

用于使用 .env 文件的库。您可以在网站上找到完整的文档
https://quillstack.org/dotenv

.env 应用于敏感信息,如密码、主机、密钥、凭证以及所有可能根据环境改变的值,例如调试模式设置或日志级别。

安装

要安装此包,请使用 Composer 运行标准命令

composer require quillstack/dotenv

用法

当您想在项目中使用 .env 文件时,可以使用 Quillstack Dotenv 包。

简单用法

如果您在项目的根目录中创建了 .env 文件

APP_DEBUG=true

您可以在应用程序中加载此 .env 文件

$dotenv = new Dotenv('.env');
$dotenv->load();

每次您需要知道应用程序是否处于调试模式时,您都可以使用此辅助函数进行检查

if (env('APP_DEBUG')) {
    echo 'Debug mode';
}

默认值

您还可以根据上下文定义默认值

if (env('APP_DEBUG', false)) {
    echo 'Debug mode';
}

必需的键

您可以使用另一个辅助方法来处理必需的键。如果未找到必需的键,将抛出异常

$dbHost = required('DATABASE_HOST');

如果 .env 文件中未设置 DATABASE_HOST 键的结果

DotenvValueNotSetException:
Value not set for key: DATABASE_HOST

多行值

您可以在 .env 文件中使用 \n 分隔符来定义多行值,而不是使用换行符,例如

PRIVATE_KEY="line1\nline2\nline3"

单元测试

使用命令运行测试

phpdbg -qrr ./vendor/bin/unit-tests

Docker

$ docker-compose up -d
$ docker exec -w /var/www/html -it quillstack_dotenv sh