Skip to content
Another Approach for .env editing (UI icluded)
PHP HTML
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images initialize Oct 24, 2018
src a bit linting Jan 16, 2020
tests
LICENSE
README.md Change Codacy Badge Jan 2, 2020
composer.json add alias Oct 30, 2018
phpunit.xml

README.md

Codacy Badge Maintainability License

Laravel .env Editor (plus GUI)

This Package allows to manage Laravel .env file values on the Fly (add, edit, delete keys), upload another .env or create backups
Management can be done through the user interface, or programmatically by using the EnvEditor Facade, without breaking the files structure.
The inspiration for this package was -, Brotzka/laravel-dotenv-editor.

  1. Install package

    composer require geo-sot/laravel-env-editor
  2. Edit config/app.php (Skip this step if you are using laravel 5.5+) Service provider:

    GeoSot\EnvEditor\ServiceProvider::class

    Class aliases:

    'EnvEditor' => GeoSot\\EnvEditor\\Facades\\EnvEditor::class
  3. Publish assets

    php artisan vendor:publish --provider=GeoSot\EnvEditor\ServiceProvider     

    This will publish all files:

    • config -> env-editor.php
    • views -> resources/views/vendor/geo-sot/env-editor/..
    • lang -> resources/lang/vendor/geo-sot/env-editor.php

    Or publish specific tags

     //Publish specific tag
     php artisan vendor:publish --tag=config
     php artisan vendor:publish --tag=translations
     php artisan vendor:publish --tag=views
     
     //Publish specific Tag from this Vendor
     php artisan vendor:publish --provider=GeoSot\EnvEditor\ServiceProvider --tag=config  
    

Available Methods:

  • getEnvFileContent
  • keyExists
  • getKey
  • addKey
  • editKey
  • deleteKey
  • getAllBackUps
  • upload
  • backUpCurrent
  • getFilePath
  • deleteBackup
  • restoreBackUp
  
 EnvEditor::getEnvFileContent($fileName='') 
 // Return The .env Data as Collection.
 // If FileName Is provided it searches inside backups Directory and returns these results

 EnvEditor::keyExists($key)
 // Search key existance in .env
 
 EnvEditor::getKey(string $key, $default = null)    
 // Get key value from .env,

  EnvEditor::addKey($key, $value, array $options = [])
  // Adds new Key in .env file
  // As options can pass ['index'=>'someNumericIndex'] in order to place the new key after an other and not in the end,
  // or ['group'=>'MAIL/APP etc'] to place the new key oat the end of the group 

  EnvEditor::editKey($key, $nvalue)
  // Edits existing key value

  EnvEditor::deleteKey($key)    

  EnvEditor::getAllBackUps()
  // Returns all Backup files as collection with some info like, created_date, content etc.

  EnvEditor::upload(UploadedFile $uploadedFile, $replaceCurrentEnv)
  // Gets an UploadedFile and stores it as backup or as current .env

  EnvEditor::backUpCurrent()
  // Backups current .env

  EnvEditor::getFilePath($fileName = '')
  // Returns the full path of a backup file. 
  // If $fileName is empty returns the full path of the .env file

  EnvEditor::deleteBackup($fileName)
  

  EnvEditor::restoreBackUp()
  


User Interface

User Interface Contains three Tabs


Current .env

Overview

Add new key

AddKey

Edit key

EditKey

Delete key

DeleteKey

Backups

Backups Index

Overview

Backup file details

Overview

Upload

Overview

You can’t perform that action at this time.