Download the PHP package quhang/dotenv-editor without Composer
On this page you can find all versions of the php package quhang/dotenv-editor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download quhang/dotenv-editor
More information about quhang/dotenv-editor
Files in quhang/dotenv-editor
Package dotenv-editor
Short Description The .env file editor tool for Laravel 5+
License MIT
Informations about the package dotenv-editor
Laravel Dotenv Editor
[fork from JackieDo/Laravel-Dotenv-Editor] Laravel Dotenv Editor is an the .env file editor (or files with same structure and syntax) for Laravel 5+. Now you can easily edit .env files with following features:
- Read raw content of file
- Read lines in file content
- Read setters (key-value-pair) in file content
- Determine one key name of setter if exists
- Append empty lines into file
- Append comment lines into file
- Append new or update exists setter lines into file
- Delete exists setter line in file
- Backup and restore file
- Manage backup files
Documentation
Look at one of the following topics to learn more about Laravel Dotenv Editor
- Versions and compatibility
- Installation
- Configuration
- Auto backup mode
- Backup location
- Usage
- Working with facade
- Using dependency injection
- Loading file for working
- Reading file content
- Writing content into file
- Backing up and restoring file
- Method chaining
- Working with Artisan CLI
- Exceptions
- License
- Thanks from author
Versions and compatibility
Currently, Laravel Dotenv Editor only have version 1.x that is compatible with Laravel 5+ and later. This package is not support for Laravel 4.2 and earlier versions.
Installation
You can install this package through Composer.
-
First, edit your project's
composer.json
file to requirequhang/dotenv-editor
: - Next, run the composer update command in your command line interface:
Note: Instead of performing the above two steps, you can perform faster with the command line
$ composer require quhang/dotenv-editor:1.*
.
-
Once update operation completes, the third step is add the service provider. Open
config/app.php
, and add a new item to the providers array: - The next step is add the follow line to the section
aliases
in fileconfig/app.php
:
Configuration
To get started, you'll need to publish configuration file:
This will create a config/dotenv-editor.php
file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
Auto backup mode
The option autoBackup
is determine that your orignal file will be backed up before save or not.
Backup location
The option backupPath
is where that your file is backed up to. This value is the sub path (sub-folder) from root folder of project application.
Usage
Working with facade
Laravel Dotenv Editor has a facade with name is Jackiedo\DotenvEditor\Facades\DotenvEditor
. You can do any operation through this facade. For example:
<?php namespace Your\Namespace;
...
use Jackiedo\DotenvEditor\Facades\DotenvEditor;
class YourClass
{
public function yourMethod()
{
DotenvEditor::doSomething();
}
}
Using dependency injection
This package also supports dependency injection, you can easily use dependency injection to inject an instance of the Jackiedo\DotenvEditor\DotenvEditor
class into your controller or other class. Example:
<?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();
}
}
Loading file for working
Default, Laravel Dotenv Editor will load file .env
in root folder of your project whenever you use the DotenvEditor
facade. Example:
$content = DotenvEditor::getContent(); // Get raw content of file .env in root folder
However, if you want to explicitly specify what files you will work with, you should use method load()
. Example:
$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/
Method load()
have three parameters:
$file = DotenvEditor::load($filePath, $restoreIfNotFound, $restorePath);
- The first parameter is the path to file you want to work with. Set
null
to work with file.env
in root folder. - The second parameter is allow restoring your file if it is not found.
- The third parameter is the path to file use to restoring. Set
null
to restore from a earlier backup file.
Reading file content
Reading raw content.
You can use method getContent()
to get raw content in your file. Example:
$content = DotenvEditor::getContent();
This will return raw file content as a string
Reading content by lines.
Use method getLines()
to get all lines in your file. Example:
$lines = DotenvEditor::getLines();
This will return an array. Each element in array, you can see following info:
- Number of line
- Raw content of line
- Parsed content of line, include: type of line (empty, comment, setter...), key name of setter, value of setter, comment of setter...
Reading content by keys
Use method getKeys($keys = [])
to get all setter lines in your file. Example:
$keys = DotenvEditor::getKeys(); // Get all keys
$keys = DotenvEditor::getKeys(['APP_DEBUG', 'APP_URL']); // Only get two given keys if exists
This will return an array. Each element in array, you can see following info:
- Number of line
- Key name of setter
- Value of setter
- Comment of setter
- This key used "export " command or not
Determine if key is exists
Use method keyExists($key)
. Example:
$keyExists = DotenvEditor::keyExists('APP_URL'); // Return true|false
Get value of a key
Use method getValue($key)
. Example:
$value = DotenvEditor::getValue('APP_URL');
Writing content into file
To edit file content, you have two job:
- First is writing content into buffer
- Second is saving buffer into file
Add an empty line into buffer
Use method addEmpty()
. Example:
$file = DotenvEditor::addEmpty();
Add a comment line into buffer
Use method addComment($comment)
. Example:
$file = DotenvEditor::addComment('This is a comment line');
Add or update a setter into buffer
Use method setKey($key, $value = null, $comment = null, $export = false)
. Example:
$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
Add or update multi setter into buffer
Use method setKeys($data)
. Example:
$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',
]
]);
Delete a setter line in buffer
Use method deleteKey($key)
. Example:
$file = DotenvEditor::deleteKey('ENV_KEY');
Delete multi setter lines in buffer
Use method deleteKeys($keys)
. Example:
$file = DotenvEditor::deleteKeys(['ENV_KEY_1', 'ENV_KEY_2']); // Delete two keys
Save buffer into file
$file = DotenvEditor::save();
Backing up and restoring file
Backup your file
$file = DotenvEditor::backup();
Get all backup versions
$backups = DotenvEditor::getBackups();
Get latest backup version
$latestBackup = DotenvEditor::getLatestBackup();
Restore your file from latest backup or other file
$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
Delete one backup file
$file = DotenvEditor::deleteBackup(storage_path('dotenv-editor/backups/.env.backup_2017_04_10_152709'));
Delete multi backup files
$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
Change auto backup mode
$file = DotenvEditor::autoBackup(true); // Enable auto backup
$file = DotenvEditor::autoBackup(false); // Disable auto backup
Method chaining
Some functions of loading, writing, backing up, restoring are implementation and usage of method chaining. So these functions can be called to chained together in a single statement. Example:
$file = DotenvEditor::load('.env.example')->backup()->setKey('APP_URL', 'http://example.com')->save();
return $file->getKeys();
Working with Artisan CLI
Now, Laravel Dotenv Editor have total 6 commands can use easily with Artisan CLI. Such as:
- 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
Please use each above command with option --help for details of usage. Example:
Exceptions
License
MIT © Jackie Do
Thanks for use
Hopefully, this package is useful to you.
All versions of dotenv-editor with dependencies
illuminate/config Version >=5.0
illuminate/container Version >=5.0
illuminate/support Version >=5.0