README

Laravel Dotenv Editor 是用于 Laravel 5+ 的 .env 文件编辑器（或具有相同结构和语法的文件）。现在您可以轻松地使用以下功能编辑 .env 文件

读取文件原始内容
读取文件内容中的行
读取文件内容中的设置器（键值对）
如果存在，确定一个设置器的键名
将空行追加到文件中
将注释行追加到文件中
将新行或更新现有设置器行追加到文件中
删除文件中的现有设置器行
备份和恢复文件
管理备份文件

文档

查看以下主题以了解更多关于 Laravel Dotenv Editor 的信息

版本和兼容性
安装
配置
- 自动备份模式
- 备份位置
使用方法
许可
感谢作者

版本和兼容性

目前，Laravel Dotenv Editor 只有一个与 Laravel 5+ 和更高版本兼容的 1.x 版本。此包不支持 Laravel 4.2 及更早版本。

安装

您可以通过 Composer 安装此包。

首先，编辑您的项目 composer.json 文件以要求 jackiedo/dotenv-editor

...
"require": {
    ...
    "jackiedo/dotenv-editor": "1.*"
},

接下来，在您的命令行界面中运行 composer update 命令

$ composer update

注意：除了执行上述两个步骤之外，您还可以通过命令行 $ composer require jackiedo/dotenv-editor:1.* 更快地执行。

更新操作完成后，第三步是添加服务提供者。打开 config/app.php，并在 providers 数组中添加一个新项

...
'providers' => array(
    ...
    Jackiedo\DotenvEditor\DotenvEditorServiceProvider::class,
),

下一步是在文件 config/app.php 的 aliases 部分添加以下行

'DotenvEditor' => Jackiedo\DotenvEditor\Facades\DotenvEditor::class,

配置

要开始使用，您需要发布配置文件

$ php artisan vendor:publish --provider="Jackiedo\DotenvEditor\DotenvEditorServiceProvider" --tag="config"

这将在您的应用程序中创建一个 config/dotenv-editor.php 文件，您可以修改它以设置您的配置。同时，确保检查此包中原始配置文件之间的更改。

自动备份模式

选项 autoBackup 用于确定在保存之前是否备份原始文件。

备份位置

选项 backupPath 是文件备份的位置。此值是项目应用程序根文件夹的子路径（子文件夹）。

使用方法

使用外观

Laravel Dotenv Editor 有一个名为 Jackiedo\DotenvEditor\Facades\DotenvEditor 的外观。您可以通过此外观执行任何操作。例如

<?php namespace Your\Namespace;

...

use Jackiedo\DotenvEditor\Facades\DotenvEditor;

class YourClass
{
    public function yourMethod()
    {
        DotenvEditor::doSomething();
    }
}

使用依赖注入

此包还支持依赖注入，您可以通过依赖注入轻松地将 Jackiedo\DotenvEditor\DotenvEditor 类的实例注入到控制器或其他类中。示例

<?php namespace App\Http\Controllers;

...

use Jackiedo\DotenvEditor\DotenvEditor;

class TestDotenvEditorController extends Controller {

    protected $editor;

    public function __construct(DotenvEditor $editor)
    {
        $this->editor = $editor;
    }

    public function doSomething()
    {
        $editor = $this->editor->doSomething();
    }
}

加载文件进行工作

默认情况下，Laravel Dotenv Editor 将在您使用 DotenvEditor 外观时加载项目根目录下的 .env 文件。示例

$content = DotenvEditor::getContent(); // Get raw content of file .env in root folder

但是，如果您想显式指定要处理的文件，应使用 load() 方法。示例

$file = DotenvEditor::load(); // Working with file .env in root folder
$file = DotenvEditor::load('.env.example'); // Working with file .env.example in root folder
$file = DotenvEditor::load(storage_path('dotenv-editor/backups/.env.backup')); // Working with file .env.backup in folder storage/dotenv-editor/backups/

load() 方法有三个参数

$file = DotenvEditor::load($filePath, $restoreIfNotFound, $restorePath);

第一个参数是要处理的文件路径。将 null 设置为使用根目录下的 .env 文件。
第二个参数是当文件找不到时允许恢复文件。
第三个参数是用于恢复的文件路径。设置为null将从较早的备份文件恢复。

读取文件内容

读取原始内容。

您可以使用方法getContent()获取文件中的原始内容。示例

$content = DotenvEditor::getContent();

这将返回原始文件内容作为字符串

按行读取内容。

使用方法getLines()获取文件中的所有行。示例

$lines = DotenvEditor::getLines();

这将返回一个数组。数组中的每个元素，您可以查看以下信息

行号
行的原始内容
行的解析内容，包括：行的类型（空行、注释、setter...）、setter的键名、setter的值、setter的注释...

按键读取内容。

使用方法getKeys($keys = [])获取文件中的所有setter行。示例

$keys = DotenvEditor::getKeys(); // Get all keys
$keys = DotenvEditor::getKeys(['APP_DEBUG', 'APP_URL']); // Only get two given keys if exists

这将返回一个数组。数组中的每个元素，您可以查看以下信息

行号
setter的键名
setter的值
setter的注释
此键是否使用了"export "命令

确定键是否存在

使用方法keyExists($key)。示例

$keyExists = DotenvEditor::keyExists('APP_URL'); // Return true|false

获取键的值

使用方法getValue($key)。示例

$value = DotenvEditor::getValue('APP_URL');

将内容写入文件

要编辑文件内容，您有两个任务

第一个是将内容写入缓冲区
第二个是将缓冲区内容保存到文件

向缓冲区中添加一个空行

使用方法addEmpty()。示例

$file = DotenvEditor::addEmpty();

向缓冲区中添加一个注释行

使用方法addComment($comment)。示例

$file = DotenvEditor::addComment('This is a comment line');

向缓冲区中添加或更新一个setter

使用方法setKey($key, $value = null, $comment = null, $export = false)。示例

$file = DotenvEditor::setKey('ENV_KEY'); // Set key ENV_KEY with empty value
$file = DotenvEditor::setKey('ENV_KEY', 'anything-you-want'); // Set key ENV_KEY with none empty value
$file = DotenvEditor::setKey('ENV_KEY', 'anything-you-want', 'your-comment'); // Set key ENV_KEY with a value and comment
$file = DotenvEditor::setKey('ENV_KEY', 'new-value-1'); // Update key ENV_KEY with a new value and keep earlier comment
$file = DotenvEditor::setKey('ENV_KEY', 'new-value', null, true); // Update key ENV_KEY with a new value, keep earlier comment and use 'export ' before key name
$file = DotenvEditor::setKey('ENV_KEY', 'new-value-2', '', false); // Update key ENV_KEY with a new value and clear comment

向缓冲区中添加或更新多个setter

使用方法setKeys($data)。示例

$file = DotenvEditor::setKeys([
    [
        'key'     => 'ENV_KEY_1',
        'value'   => 'your-value-1',
        'comment' => 'your-comment-1',
        'export'  => true
    ],
    [
        'key'     => 'ENV_KEY_2',
        'value'   => 'your-value-2',
        'export'  => true
    ],
    [
        'key'     => 'ENV_KEY_3',
        'value'   => 'your-value-3',
    ]
]);

删除缓冲区中的setter行

使用方法deleteKey($key)。示例

$file = DotenvEditor::deleteKey('ENV_KEY');

删除缓冲区中的多个setter行

使用方法deleteKeys($keys)。示例

$file = DotenvEditor::deleteKeys(['ENV_KEY_1', 'ENV_KEY_2']); // Delete two keys

将缓冲区内容保存到文件

$file = DotenvEditor::save();

备份和恢复文件

备份您的文件

$file = DotenvEditor::backup();

获取所有备份版本

$backups = DotenvEditor::getBackups();

获取最新的备份版本

$latestBackup = DotenvEditor::getLatestBackup();

从最新的备份或其他文件恢复您的文件

$file = DotenvEditor::restore(); // Restore from latest backup
$file = DotenvEditor::restore(storage_path('dotenv-editor/backups/.env.backup_2017_04_10_152709')); // Restore from other file

删除一个备份文件

$file = DotenvEditor::deleteBackup(storage_path('dotenv-editor/backups/.env.backup_2017_04_10_152709'));

删除多个备份文件

$file = DotenvEditor::deleteBackups([
    storage_path('dotenv-editor/backups/.env.backup_2017_04_10_152709'),
    storage_path('dotenv-editor/backups/.env.backup_2017_04_11_091552')
]); // Delete two backup file

$file = DotenvEditor::deleteBackups(); // Delete all backup

更改自动备份模式

$file = DotenvEditor::autoBackup(true); // Enable auto backup
$file = DotenvEditor::autoBackup(false); // Disable auto backup

方法链

加载、写入、备份、恢复的一些功能是方法链的实现和使用。因此，这些函数可以调用在一起，在单个语句中。示例

$file = DotenvEditor::load('.env.example')->backup()->setKey('APP_URL', 'http://example.com')->save();
return $file->getKeys();

使用 Artisan CLI

现在，Laravel Dotenv Editor有6个可以通过Artisan CLI轻松使用的命令。例如

php artisan dotenv:backup
php artisan dotenv:get-backups
php artisan dotenv:restore
php artisan dotenv:get-keys
php artisan dotenv:set-key
php artisan dotenv:delete-key

请使用上述每个命令的--help选项以获取使用详情。示例

$ php artisan dotenv:get-backups --help

grantholle / laravel-dotenv-editor

维护者

详细信息