README

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.

• Installation

• Available Methods

• User Interface

  Installation:

1. Install package

   composer require ijagjeet/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, $value)
  // 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
  • Add new Key
  • Edit Key
  • Delete new Key
• Backups
  • Backups Index
  • Backup file details
• Upload

Current .env

Add new key

Edit key

Delete key

Backups

Backups Index

Backup file details

Upload