laravel er diagram generator

Laravel ER-Diagrammgenerator

Mit diesem Paket können Sie Entity-Relations-Diagramme erstellen, indem Sie die in Ihren Modelldateien definierten Beziehungen überprüfen. Es ist hochgradig anpassbar. Im Hintergrund wird GraphViz zum Generieren des Diagramms verwendet.

Wenn Sie lernen möchten, wie Sie wiederverwendbare PHP-Pakete selbst erstellen, schauen Sie sich meinen kommenden Videokurs zur PHP-Paketentwicklung an.

Voraussetzungen

Die mindestens erforderliche PHP-Version ist 7.1.0.

Anforderungen

Für dieses Paket ist das Tool graphviz erforderlich.

Sie können Graphviz unter MacOS über Homebrew installieren:

brew install graphviz

Oder, wenn Sie Homestead verwenden:

sudo apt-get install graphviz

Um Graphviz unter Windows zu installieren, laden Sie es von der offiziellen Website herunter.

Installation

Sie können das Paket über Composer installieren:

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

Wenn Sie Laravel 5.5+ verwenden, registriert das Paket automatisch den Dienstanbieter für Sie.

Wenn Sie Lumen verwenden, müssen Sie Folgendes zu bootstrapapp.php hinzufügen:

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

Verwendung

Standardmäßig erkennt das Paket automatisch alle Modelle in Ihrem app/Models -Verzeichnis, die die Eloquent Model-Klasse erweitern. Wenn Sie explizit definieren möchten, wo sich Ihre Modelle befinden, können Sie die Konfigurationsdatei mit dem folgenden Befehl veröffentlichen.

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

Wenn Sie Lumen verwenden und die Konfiguration anpassen möchten, müssen Sie die Konfigurationsdatei aus dem Anbieterverzeichnis kopieren:

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

Diagramme erstellen

Sie können Entity-Relations-Diagramme mit dem bereitgestellten artisan-Befehl erstellen:

php artisan generate:erd

Dadurch wird eine Datei namens graph.png generiert.

Sie können auch einen benutzerdefinierten Dateinamen angeben:

php artisan generate:erd output.png

Oder verwenden Sie eines der anderen Ausgabeformate, wie SVG:

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

Anpassung

Bitte werfen Sie einen Blick auf die veröffentlichte Konfigurationsdatei erd-generator.php für alle verfügbaren Anpassungsoptionen.

Beispiele

Hier sind einige Beispiele aus der Laravel.io-Codebasis.

Testen

composer test

Änderungsprotokoll

Weitere Informationen zu den letzten Änderungen finden Sie im CHANGELOG.

Mitwirken

Weitere Informationen finden Sie unter BEITRAGEN.

Sicherheit

Wenn Sie sicherheitsrelevante Probleme entdecken, senden Sie bitte eine E-Mail an [email protected], anstatt den Issue-Tracker zu verwenden.

Credits

• Marcel Pociot
• Alle Mitwirkenden

Lizenz

Die MIT-Lizenz (MIT). Weitere Informationen finden Sie in der Lizenzdatei.