benfiratkaya/laravel-setenv

A .env editor for Laravel

1.0 2022-04-17 10:53 UTC

Requires

• php: ^7.3|^8.0
• laravel/framework: ^7.0|^8.74|^9.0

Requires (Dev)

• orchestra/testbench: ^4.0|^5.0|^6.4
• phpunit/phpunit: ^8.0|^9.5.8
• roave/security-advisories: dev-master

MIT

• David Cortés

README

Inspired by JackieDo/Laravel-Dotenv-Editor, it is a simplified version without a visual editor.

Installation

You can install this package through Composer with the following steps:

Step 1 - Require package

At the root of your application directory, run the following command:

$ composer require dacoto/laravel-setenv

Usage

Working with facade

Laravel Set Env has a facade with the name dacoto\SetEnv\Facades\SetEnv. You can perform all operations through this facade.

Example:

<?php namespace Your\Namespace;

// ...

use dacoto\SetEnv\Facades\SetEnv;

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

Using dependency injection

This package also supports dependency injection. You can easily inject an instance of the dacoto\SetEnv class into your controller or other classes.

Example:

<?php namespace App\Http\Controllers;

// ...

use dacoto\SetEnv;

class TestSetEnvController extends Controller
{
    protected $editor;

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

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

Reading file content

Reading raw content.

Method syntax:

/**
 * Get raw content of file
 *
 * @return string
 */
public function getContent();

Example:

$rawContent = SetEnv::getContent();

Reading content by lines.

Method syntax:

/**
 * Get all lines from file
 *
 * @return array
 */
public function getLines();

Example:

$lines = SetEnv::getLines();

Note: This will return an array. Each element in the array consists of the following items:

• Number of the line.
• Raw content of the line.
• Parsed content of the line, including: type of line (empty, comment, setter...), key name of setter, value of setter, comment of setter...

Reading content by keys

Method syntax:

/**
 * Get all or exists given keys in file content
 *
 * @param  array  $keys
 *
 * @return array
 */
public function getKeys($keys = []);

Example:

// Get all keys
$keys = SetEnv::getKeys();

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

Note: This will return an array. Each element in the array consists of the following items:

• Number of the line.
• Key name of the setter.
• Value of the setter.
• Comment of the setter.
• If this key is used for the "export" command or not.

Determine if a key exists

Method syntax:

/**
 * Check, if a given key is exists in the file content
 *
 * @param  string  $keys
 *
 * @return bool
 */
public function keyExists($key);

Example:

$keyExists = SetEnv::keyExists('APP_URL');

Get value of a key

Method syntax:

/**
 * Return the value matching to a given key in the file content
 *
 * @param  $key
 *
 * @throws \dacoto\SetEnv\Exceptions\KeyNotFoundException
 *
 * @return string
 */
public function getValue($key);

Example:

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

Note: To apply the changes to the file, you have to save it with the save method.

Writing content into a file

To edit file content, you have two jobs:

• First is writing content into the buffer
• Second is saving the buffer into the file

Add an empty line into buffer

Method syntax:

/**
 * Add empty line to buffer
 *
 * @return SetEnv
 */
public function addEmpty();

Example:

$file = SetEnv::addEmpty();

Add a comment line into buffer

Method syntax:

/**
 * Add comment line to buffer
 *
 * @param object
 *
 * @return SetEnv
 */
public function addComment($comment);

Example:

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

Add or update a setter into buffer

Method syntax:

/**
 * Set one key to buffer
 *
 * @param string       $key      Key name of setter
 * @param string|null  $value    Value of setter
 * @param string|null  $comment  Comment of setter
 * @param boolean      $export   Leading key name by "export "
 *
 * @return SetEnv
 */
public function setKey($key, $value = null, $comment = null, $export = false);

Example:

// Set key ENV_KEY with empty value
$file = SetEnv::setKey('ENV_KEY');

// Set key ENV_KEY with none empty value
$file = SetEnv::setKey('ENV_KEY', 'anything-you-want');

// Set key ENV_KEY with a value and comment
$file = SetEnv::setKey('ENV_KEY', 'anything-you-want', 'your-comment');

// Update key ENV_KEY with a new value and keep earlier comment
$file = SetEnv::setKey('ENV_KEY', 'new-value-1');

// Update key ENV_KEY with a new value, keep earlier comment and use 'export ' before key name
$file = SetEnv::setKey('ENV_KEY', 'new-value', null, true);

// Update key ENV_KEY with a new value and clear comment
$file = SetEnv::setKey('ENV_KEY', 'new-value-2', '', false);

Add or update multi setter into buffer

Method syntax:

/**
 * Set many keys to buffer
 *
 * @param  array  $data
 *
 * @return SetEnv
 */
public function setKeys($data);

Example:

$file = SetEnv::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',
    ]
]);

Alternatively, you can also provide an associative array of keys and values:

$file = SetEnv::setKeys([
    'ENV_KEY_1' => 'your-value-1',
    'ENV_KEY_2' => 'your-value-2',
    'ENV_KEY_3' => 'your-value-3',
]);

Delete a setter line in buffer

Method syntax:

/**
 * Delete on key in buffer
 *
 * @param  string  $key
 *
 * @return SetEnv
 */
public function deleteKey($key);

Example:

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

Delete multi setter lines in buffer

Method syntax:

/**
 * Delete many keys in buffer
 *
 * @param  array $keys
 *
 * @return SetEnv
 */
public function deleteKeys($keys = []);

Example:

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

Save buffer into file

Method syntax:

/**
 * Save buffer to file
 *
 * @return SetEnv
 */
public function save();

Example:

$file = SetEnv::save();

Exceptions

This package will throw exceptions if something goes wrong. This way it's easier to debug your code using this package or to handle the error based on the type of exceptions.

Exception	Reason
FileNotFoundException	When the file was not found.
InvalidValueException	When the value of setter is invalid.
KeyNotFoundException	When the requested key does not exist in file.
UnableReadFileException	When unable to read the file.
UnableWriteToFileException	When unable to write to the file.

License

MIT © 2022 dacoto