laravel er diagram generator

Генератор диаграмм Laravel ER

Этот пакет позволяет создавать диаграммы отношений сущностей, проверяя отношения, определенные в файлах вашей модели. Это очень настраиваемый. За кулисами он использует GraphViz для создания графика.

Если вы хотите научиться самостоятельно создавать многоразовые пакеты PHP, посмотрите мой предстоящий видеокурс «Разработка пакетов PHP».

Предварительные условия

Минимальная необходимая версия PHP — 7.1.0.

Требования

Для этого пакета требуется инструмент graphviz .

Вы можете установить Graphviz на MacOS с помощью доморощенного:

brew install graphviz

Или, если вы используете Homestead:

sudo apt-get install graphviz

Чтобы установить Graphviz на Windows, загрузите его с официального сайта.

Установка

Вы можете установить пакет через композитор:

composer require beyondcode/laravel-er-diagram-generator --dev

Если вы используете Laravel 5.5+, пакет автоматически зарегистрирует для вас поставщика услуг.

Если вы используете Lumen, вам нужно будет добавить следующее в bootstrapapp.php :

 # Register Service Providers
$ app -> register ( BeyondCode  ErdGenerator  ErdGeneratorServiceProvider ::class);

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

По умолчанию пакет автоматически обнаружит все модели в вашем каталоге app/Models , которые расширяют класс Eloquent Model. Если вы хотите явно указать, где расположены ваши модели, вы можете опубликовать файл конфигурации с помощью следующей команды.

php artisan vendor:publish --provider=BeyondCode \ ErdGenerator \ ErdGeneratorServiceProvider

Если вы используете Lumen и хотите настроить конфигурацию, вам необходимо скопировать файл конфигурации из каталога поставщика:

cp ./vendor/beyondcode/laravel-er-diagram-generator/config/config.php config/erd-generator.php

Создание диаграмм

Вы можете создавать диаграммы отношений сущностей, используя предоставленную ремесленную команду:

php artisan generate:erd

Это создаст файл с graph.png .

Вы также можете указать собственное имя файла:

php artisan generate:erd output.png

Или используйте один из других выходных форматов, например SVG:

php artisan generate:erd output.svg --format=svg

Кастомизация

Пожалуйста, ознакомьтесь со всеми доступными параметрами настройки в опубликованном файле конфигурации erd-generator.php .

Примеры

Вот несколько примеров, взятых из базы кода Laravel.io.

Тестирование

composer test

Журнал изменений

Пожалуйста, посетите CHANGELOG для получения дополнительной информации о том, что изменилось за последнее время.

Содействие

Пожалуйста, смотрите ВКЛАД для получения подробной информации.

Безопасность

Если вы обнаружите какие-либо проблемы, связанные с безопасностью, отправьте электронное письмо по адресу [email protected] вместо использования системы отслеживания проблем.

Кредиты

• Марсель Посьо
• Все участники

Лицензия

Лицензия MIT (MIT). Пожалуйста, смотрите файл лицензии для получения дополнительной информации.