boomdraw/laravel-dotenv

Laravel 环境变量管理器

v2.1.0 2021-02-11 01:09 UTC

This package is auto-updated.

Last update: 2024-09-11 09:05:22 UTC


README

允许读写 .env 文件变量的包

安装

通过 Composer

composer require boomdraw/laravel-dotenv

该包将自动注册自己。

您可以使用以下命令发布配置文件:

php artisan vendor:publish --provider="Boomdraw\Dotenv\DotenvServiceProvider" --tag="config"

使用方法和函数

use Dotenv;
//or
use Boomdraw\Dotenv\Facades\Dotenv;
//or
use Boomdraw\Dotenv\Contracts\DotenvContract;

class Controller
{
    /**
     * @var \Boomdraw\Dotenv\Repositories\DotenvRepository
     */
    protected $dotenv;

    public function __construct(DotenvContract $dotenv)
    {
        $this->dotenv = $dotenv;
    }
}

all

Dotenv::all(): Collection

该函数返回所有 .env 变量为 \Illuminate\Support\Collection 对象。

set

Dotenv::set($key, ?string $value = null): self

该函数在不考虑变量存在与否的情况下写入 .env 变量。

Dotenv::setEmpty($key, ?string $value = null): self

如果变量不存在或为空,该函数将写入 .env 变量。

add

Dotenv::add($key, ?string $value = null): self

如果变量不存在,该函数将添加 .env 变量。

put

Dotenv::put($key, ?string $value = null): self

如果变量存在,该函数将更新 .env 变量。

Dotenv::putEmpty($key, ?string $value = null): self

如果变量存在且为空,该函数将更新 .env 变量。

delete

Dotenv::delete($key): self

该函数删除 .env 变量。

可以通过 $key 变量传递要删除的键的数组。

设置器功能

您可以将数据作为数组传递给设置器(setaddput

Dotenv::set['key1' => 'value1', 'key2' => 'value2']

设置器将变量名中的引号('")、空格( )和连字符(-)替换为下划线(_),并将名称转换为大写。

例如,Dotenv::set('foo bar', 'baz') 将将 FOO_BAR=baz 写入 .env 文件。

所有设置器和 delete 都会立即重写 .env 文件。

reload

Dotenv::reload(): self

该函数从文件系统重新加载 .env 文件。

集合方法

您可以使用所有 集合 方法。例如

Dotenv::get('APP_NAME') 返回 APP_NAME 的值。

Dotenv::has('APP_NAME') 检查 APP_NAME 变量的存在。

所有集合方法都是对 Dotenv 集合的副本进行调用的,因此对集合的任何更改都不会影响 .env 文件和 Dotenv 内容。

测试

您可以使用以下命令运行测试

composer test

安全

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

许可证

MIT