README

redot/dotenv-editor 是一个 PHP 包，它提供了一个简单便捷的方式来读取、修改和保存从 .env 文件中获取的环境变量。它利用了 Dotenv 包来解析环境文件。

安装

您可以通过 Composer 安装此包

composer require redot/dotenv-editor

用法

创建实例

要使用 DotenvEditor 类，通过提供 .env 文件的路径来创建一个实例

use Redot\DotenvEditor\DotenvEditor;

$editor = new DotenvEditor('/path/to/.env');

可选地，您可以传递第二个参数来启用备份功能

$editor = new DotenvEditor('/path/to/.env', true);

获取环境变量

您可以通过指定其键来检索环境变量的值

$value = $editor->get('KEY');

如果找不到键，您可以提供一个默认值，该值将被返回

$value = $editor->get('KEY', 'default');

设置环境变量

要设置环境变量的值，请使用 set 方法

$editor->set('KEY', 'value');

保存更改

修改环境变量后，您需要将更改保存回 .env 文件

$editor->save();

这将用更新的变量覆盖现有文件。

备份功能

默认情况下，备份功能是禁用的。如果您想启用它，在创建 DotenvEditor 实例时将 true 作为第二个参数传递

$editor = new DotenvEditor('/path/to/.env', true);

这将创建一个备份文件（.env.backup），在保存任何更改之前。备份文件将包含 .env 文件的上一版本。

注意：每次您再次备份 .env 文件时，备份文件将被覆盖。

示例

以下是如何使用 DotenvEditor 类的示例

use Redot\DotenvEditor\DotenvEditor;
use Redot\DotenvEditor\Exceptions\FileNotFoundException;

try {
    $editor = new DotenvEditor('/path/to/.env');

    $editor->set('APP_ENV', 'production');
    $editor->set('APP_DEBUG', 'false');

    $editor->save();

    echo 'Changes saved successfully.';
} catch (FileNotFoundException $e) {
    echo 'The file could not be found.';
}

测试

该包包含一个测试套件，可以使用 Pest 运行。运行以下命令

composer test

许可协议

此软件包是开源软件，受 MIT 许可协议许可。

redot / dotenv-editor

维护者

详细信息