Главная страница>Ресурсы для создания веб-сайтов>Другие ресурсы
Скачать

Редактор Laravel Dotenv

Редактор Laravel Dotenv - это редактор файлов .env (или файлы с той же структурой и синтаксисом) для Laravel 5.8+. Теперь вы можете легко отредактировать файлы .ENV со следующими функциями:

  • Прочитайте необработанное содержание файла.
  • Прочитайте записи содержимого файла.
  • Читать сеттеры (Key-Value-Pair) в содержимое файла.
  • Проверьте наличие сеттера.
  • Добавьте пустые строки к содержимому файла.
  • Добавить строки комментариев к содержимому файла.
  • Добавьте новый или обновите существующую запись Setter.
  • Обновите комментарий существующей записи сеттера.
  • Обновление статуса экспорта существующей записи сеттера.
  • Удалить существующую запись SETTER в содержимое файла.
  • Резервное копирование и восстановить содержимое файла.
  • Управление резервными файлами.

Версии и совместимость

Редактор Laravel Dotenv совместим с Laravel 5.8 и позже.

Важное примечание для версии 2.x

После выпуска 1.2.1 версия 1.x будет прекращена в пользу новой версии (версия 2.x ) с некоторыми изменениями, которые будут совместимы с методом анализа пакета vlucas/phpdotenv . Версия 2.x сильно изменилась по сравнению с предыдущей версией. Если вы использовали более ранние версии этого пакета, внимательно перечитайте инструкции.

Документация

Посмотрите на одну из следующих тем, чтобы узнать больше о редакторе Laravel Dotenv:

  • Установка
  • Конфигурация
    • Автоподобный режим резервного копирования
    • Место резервного копирования
    • Всегда создавайте папку резервного копирования
  • Использование
    • Работа с фасадом
    • Использование инъекции зависимостей
    • Загрузка файла для работы
    • Чтение содержимого файла
    • Редактировать содержимое файла
    • Резервное копирование и восстановление файла
    • Метод цепочка
    • Работа с Artisan CLI
    • Исключения

Установка

Вы можете установить этот пакет через композитор. В корне вашего каталога приложений запустите следующую команду (в любом клиенте терминала): 

$ composer require jackiedo/dotenv-editor

Конфигурация

Чтобы начать использование пакета, вы должны опубликовать файл конфигурации, чтобы вы могли настроить пакет по мере необходимости. Для этого запустите следующую команду (в любом клиенте терминала) в корне вашего приложения: 

$ php artisan vendor:publish --provider= " JackiedoDotenvEditorDotenvEditorServiceProvider " --tag= " config "

Это создаст файл config/dotenv-editor.php в вашем приложении, который вы можете изменить для установки вашей конфигурации. Кроме того, убедитесь, что вы проверяете изменения в исходном файле конфигурации в этом пакете между выпусками. В настоящее время есть следующие настройки:

Автоподобный режим резервного копирования

Настройка autoBackup позволяет автоматически создавать резервное копирование вашего исходного файла перед сохранением. Установите его на true , чтобы согласиться.

Место резервного копирования

Настройка backupPath используется для указания, где ваш файл резервирован. Это значение представляет собой поместный путь (подпад) из корневой папки приложения проекта.

Всегда создавайте папку резервного копирования

Настройка alwaysCreateBackupFolder используется для запроса, чтобы всегда была создана папка резервного копирования, независимо от того, выполняется ли резервное копирование.

Использование

Работа с фасадом

Редактор Laravel Dotenv имеет фасад с именем JackiedoDotenvEditorFacadesDotenvEditor . Вы можете выполнить все операции через этот фасад.

Пример: 

 <?php namespace Your  Namespace ;

// ...

use Jackiedo  DotenvEditor  Facades  DotenvEditor ;

class YourClass
{
    public function yourMethod ()
    {
        $ return = DotenvEditor:: doSomething ();
    }
}

Использование инъекции зависимостей

Этот пакет также поддерживает инъекцию зависимости. Вы можете легко ввести экземпляр класса JackiedoDotenvEditorDotenvEditor в свой контроллер или другие классы.

Пример: 

 <?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 ()
    {
        $ return = $ this -> editor -> doSomething ();
    }
}

Загрузка файла для работы

По умолчанию редактор Laravel Dotenv загрузит файл dotenv, который Laravel читает в вашем проекте. То есть, если ваш Laravel использует файл .env.local для хранения значений конфигурации, редактор Laravel Dotenv также загружает содержимое из этого файла по умолчанию.

Однако, если вы хотите явно указать файлы, с которыми вы собираетесь работать, вы должны использовать метод load() .

Синтаксис метода: 

 /**
 * Load file for working
 *
 * @param  string|null  $filePath           The file path
 * @param  boolean      $restoreIfNotFound  Restore this file from other file if it's not found
 * @param  string|null  $restorePath        The file path you want to restore from
 *
 * @return DotenvEditor
 */
public function load( $ filePath = null , $ restoreIfNotFound = false , $ restorePath = null );

Пример: 

 // Working with the dotenv file that Laravel is using
$ editor = DotenvEditor:: load ();

// Working with file .env.example in root folder of project
$ editor = DotenvEditor:: load ( base_path ( ' .env.example ' ));

// Working with file .env.backup in folder storage/dotenv-editor/backups/
$ editor = DotenvEditor:: load ( storage_path ( ' dotenv-editor/backups/.env.backup ' ));

Примечание. Метод load() имеет три параметра:

  • $filePath : путь к файлу, с которым вы хотите работать. Установите null для работы с файлом .env в корневой папке.
  • $restoreIfNotFound : Позволяет восстановить ваш файл, если он не найден.
  • $restorePath : путь к файлу, используемому для восстановления. Установите null , чтобы восстановить из более старого файла резервного копирования.

Чтение содержимого файла

Чтение необработанного контента.

Синтаксис метода: 

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

Пример: 

 $ rawContent = DotenvEditor:: getContent ();

Чтение контента по записям.

Синтаксис метода: 

 /**
 * Get all entries from file
 *
 * @return array
 */
public function getEntries( bool $ withParsedData = false );

Пример: 

 $ lines = DotenvEditor:: getEntries ( true );

Примечание: это вернет массив. Каждый элемент в массиве состоит из следующих пунктов:

  • Начальная строка номер входа.
  • Необработанное содержание записи.
  • Проанализированное содержание записи (если $withParsedData установлен на true ), включая: тип записи (пустой, комментарий, сеттер ...), имя сеттера, значение Setter, комментарий Setter ...

Чтение контента по ключам

Синтаксис метода: 

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

Пример: 

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

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

Примечание: это вернет массив. Каждый элемент в массиве состоит из следующих пунктов:

  • Количество линии.
  • Ключевое имя сеттера.
  • Значение сеттера.
  • Комментарий сеттера.
  • Если этот ключ используется для команды «Экспорт» или нет.

Чтение данных конкретного ключа

Синтаксис метода: 

 /**
 * Return information of entry matching to a given key in the file content.
 *
 * @throws KeyNotFoundException
 *
 * @return array
 */
public function getKey ( $ key );

Пример: 

 // Get all keys
$ keys = DotenvEditor:: getKey ( ' EXAMPLE_KEY ' );

Определите, существует ли ключ

Синтаксис метода: 

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

Пример: 

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

Получить ценность ключа

Синтаксис метода: 

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

Пример: 

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

Редактировать содержимое файла

Чтобы редактировать контент файла, у вас есть две задания:

  • Во -первых, это написание контента в буфер.
  • Во -вторых, это сохранение буфера в файл.

Всегда имейте в виду, что содержимое буфера и файла Dotenv не будет таким же, если вы не сохранили содержимое.

Добавить пустую линию в буфер

Синтаксис метода: 

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

Пример: 

 $ editor = DotenvEditor:: addEmpty ();

Добавить строку комментариев в буфер

Синтаксис метода: 

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

Пример: 

 $ editor = DotenvEditor:: addComment ( ' This is a comment line ' );

Добавить или обновить установщик в буфер

Синтаксис метода: 

 /**
 * Set one key to|in the buffer.
 *
 * @param string      $key     Key name of setter
 * @param null|string $value   Value of setter
 * @param null|string $comment Comment of setter
 * @param null|bool   $export  Leading key name by "export "
 *
 * @return DotenvEditor
 */
public function setKey( string $ key , ? string $ value = null , ? string $ comment = null , $ export = null );

Пример: 

 // Set key ENV_KEY with empty value
$ editor = DotenvEditor:: setKey ( ' ENV_KEY ' );

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

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

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

// Update key ENV_KEY with a new value, keep previous comment and use the 'export' keyword before key name
$ editor = DotenvEditor:: setKey ( ' ENV_KEY ' , ' new value ' , null , true );

// Update key ENV_KEY with a new value, remove comment and keep previous export status
$ editor = DotenvEditor:: setKey ( ' ENV_KEY ' , ' new-value-2 ' , '' );

// Update key ENV_KEY with a new value, remove comment and export keyword
$ editor = DotenvEditor:: setKey ( ' ENV_KEY ' , ' new-value-2 ' , '' , false );

Добавить или обновить Multi Setter в буфер

Синтаксис метода: 

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

Пример: 

 $ editor = 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 ' ,
    ]
]);

В качестве альтернативы, вы также можете предоставить ассоциативный массив ключей и значений: 

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

Установить комментарий для существующего сеттера

Синтаксис метода: 

 /**
 * Set the comment for setter.
 *
 * @param string      $key     Key name of setter
 * @param null|string $comment The comment content
 *
 * @return DotenvEditor
 */
public function setSetterComment( string $ key , ? string $ comment = null );

Пример: 

 $ editor = DotenvEditor:: setSetterComment ( ' ENV_KEY ' , ' new comment ' );

Установите статус экспорта для существующего сеттера

Синтаксис метода: 

 /**
 * Set the export status for setter.
 *
 * @param string $key   Key name of setter
 * @param bool   $state Leading key name by "export "
 *
 * @return DotenvEditor
 */
public function setExportSetter( string $ key , bool $ state = true );

Пример: 

 $ editor = DotenvEditor:: setExportSetter ( ' ENV_KEY ' , false );

Удалить запись сеттера в буфере

Синтаксис метода: 

 /**
 * Delete on key in buffer
 *
 * @param string $key Key name of setter
 *
 * @return DotenvEditor
 */
public function deleteKey ( $ key );

Пример: 

 $ editor = DotenvEditor:: deleteKey ( ' ENV_KEY ' );

Удалить многочисленные записи в буфере

Синтаксис метода: 

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

Пример: 

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

Проверьте, изменился ли буфер с содержимого файла dotenv

Синтаксис метода: 

 /**
 * Determine if the buffer has changed.
 *
 * @return bool
 */
public function hasChanged ();

Сохранить буфер в файл

Синтаксис метода: 

 /**
 * Save buffer to file.
 *
 * @param bool $rebuildBuffer Rebuild buffer from content of dotenv file
 *
 * @return DotenvEditor
 */
public function save( bool $ rebuildBuffer = true );

Пример: 

 $ editor = DotenvEditor:: save ();

Резервное копирование и восстановление файла

Резервную копию вашего файла

Синтаксис метода: 

 /**
 * Create one backup of loaded file
 *
 * @return DotenvEditor
 */
public function backup ();

Пример: 

 $ editor = DotenvEditor:: backup ();

Получите все резервные версии

Синтаксис метода: 

 /**
 * Return an array with all available backups
 *
 * @return array
 */
public function getBackups ();

Пример: 

 $ backups = DotenvEditor:: getBackups ();

Получить последнюю версию резервного копирования

Синтаксис метода: 

 /**
 * Return the information of the latest backup file
 *
 * @return array
 */
public function getLatestBackup ();

Пример: 

 $ latestBackup = DotenvEditor:: getLatestBackup ();

Восстановите свой файл из последнего резервного копирования или другого файла

Синтаксис метода: 

 /**
 * Restore the loaded file from latest backup file or from special file.
 *
 * @param  string|null  $filePath
 *
 * @return DotenvEditor
 */
public function restore ( $ filePath = null );

Пример: 

 // Restore from latest backup
$ editor = DotenvEditor:: restore ();

// Restore from other file
$ editor = DotenvEditor:: restore ( storage_path ( ' dotenv-editor/backups/.env.backup_2017_04_10_152709 ' ));

Удалить один файл резервного копирования

Синтаксис метода: 

 /**
 * Delete the given backup file
 *
 * @param  string  $filePath
 *
 * @return DotenvEditor
 */
public function deleteBackup ( $ filePath );

Пример: 

 $ editor = DotenvEditor:: deleteBackup ( storage_path ( ' dotenv-editor/backups/.env.backup_2017_04_10_152709 ' ));

Удалить файлы с несколькими резервными копиями

Синтаксис метода: 

 /**
 * Delete all or the given backup files
 *
 * @param  array  $filePaths
 *
 * @return DotenvEditor
 */
public function deleteBackups ( $ filePaths = []);

Пример: 

 // Delete two backup file
$ editor = 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 all backup
$ editor = DotenvEditor:: deleteBackups ();

Изменить режим резервного копирования автоматического резервного копирования

Синтаксис метода: 

 /**
 * Switching of the auto backup mode
 *
 * @param  boolean  $on
 *
 * @return DotenvEditor
 */
public function autoBackup ( $ on = true );

Пример: 

 // Enable auto backup
$ editor = DotenvEditor:: autoBackup ( true );

// Disable auto backup
$ editor = DotenvEditor:: autoBackup ( false );

Метод цепочка

Некоторые функции загрузки, написания, резервного копирования, восстановления цепочки методов поддержки. Таким образом, эти функции можно назвать цепью вместе в одном утверждении. Пример: 

 $ editor = DotenvEditor:: load ( ' .env.example ' )-> backup ()-> setKey ( ' APP_URL ' , ' http://example.com ' )-> save ();

return $ editor -> getKeys ();

Работа с Artisan CLI

Теперь редактор Laravel Dotenv имеет 6 команд, которые можно легко использовать с ремесленным CLI. Это:

  • 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

Пожалуйста, используйте каждую из команд с опцией --help , чтобы узнать больше об использовании.

Пример: 

$ php artisan dotenv:get-backups --help

Исключения

Этот пакет вызовет исключения, если что -то пойдет не так. Таким образом, проще отлаживать ваш код, используя этот пакет или обрабатывать ошибку на основе типа исключений.

Исключение Причина
FilenotFoundException Когда файл не был найден.
InvalidKeyException Когда ключ сеттера недействителен.
InvalidValueException Когда значение установки недействителен.
KeyNotFoundException Когда запрашиваемый ключ не существует в файле.
Nobackupavailableexception Когда нет резервного файла.
UntableDeadFileException При неспособности прочитать файл.
Несоблюдение При неспособности записать в файл.

Участники

Этот проект существует благодаря всем его участникам.

Лицензия

MIT © Jackie Do

Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все