itcyborg/laravel-env-editor

支持 .Env 文件编辑和备份的 Laravel 扩展包

dev-main 2021-02-08 10:23 UTC

This package is auto-updated.

Last update: 2024-09-08 18:34:33 UTC


README

Codacy Badge Maintainability License

Laravel .env 编辑器(含 GUI)

此包允许实时管理 Laravel .env 文件中的值(添加、编辑、删除键),上传另一个 .env 或创建备份
可以通过用户界面进行管理,也可以通过使用 EnvEditor Facade 编程方式管理,而不会破坏文件结构。
此包的灵感来自于 Brotzka/laravel-dotenv-editor

  1. 安装包

    composer require geo-sot/laravel-env-editor
  2. 编辑 config/app.php (如果使用 laravel 5.5+ 则跳过此步骤) 服务提供者

    GeoSot\EnvEditor\ServiceProvider::class

    类别名

    'EnvEditor' => GeoSot\\EnvEditor\\Facades\\EnvEditor::class
  3. 发布资源

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

    这将发布所有文件

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

    或发布特定标签

     //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  
    

可用方法

  • 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()
  

用户界面

用户界面包含三个标签页


当前 .env

Overview

添加新键

AddKey

编辑键

EditKey

删除键

DeleteKey

备份

备份索引

Overview

备份文件详情

Overview

上传

Overview