laravel er diagram generator

Laravel ER図ジェネレーター

このパッケージを使用すると、モデル ファイルで定義された関係を検査してエンティティ関係図を生成できます。高度にカスタマイズ可能です。バックグラウンドで GraphViz を使用してグラフを生成します。

再利用可能な PHP パッケージを自分で作成する方法を学びたい場合は、今後の PHP パッケージ開発ビデオ コースをご覧ください。

前提条件

最低限必要な PHP バージョンは 7.1.0 です。

要件

このパッケージには、 graphvizツールが必要です。

Homebrew を使用して Graphviz を MacOS にインストールできます。

brew install graphviz

または、Homestead を使用している場合:

sudo apt-get install graphviz

Graphviz を Windows にインストールするには、公式 Web サイトからダウンロードします。

インストール

パッケージは、composer 経由でインストールできます。

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

Laravel 5.5 以降を使用している場合、パッケージはサービスプロバイダーを自動的に登録します。

Lumen を使用している場合は、以下をbootstrapapp.phpに追加する必要があります。

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

使用法

デフォルトでは、パッケージは Eloquent Model クラスを拡張するapp/Modelsディレクトリ内のすべてのモデルを自動的に検出します。モデルの配置場所を明示的に定義したい場合は、次のコマンドを使用して構成ファイルを公開できます。

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

Lumen を使用していて設定をカスタマイズしたい場合は、ベンダー ディレクトリから設定ファイルをコピーする必要があります。

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

ダイアグラムの生成

提供されているartisanコマンドを使用してエンティティ関係図を生成できます。

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)。詳細については、ライセンス ファイルを参照してください。