laravel er diagram generator

Générateur de diagramme Laravel ER

Ce package vous permet de générer des diagrammes de relations d'entités en inspectant les relations définies dans vos fichiers de modèle. Il est hautement personnalisable. En coulisses, il utilise GraphViz pour générer le graphique.

Si vous souhaitez apprendre à créer vous-même des packages PHP réutilisables, jetez un œil à mon prochain cours vidéo sur le développement de packages PHP.

Conditions préalables

La version PHP minimale requise est 7.1.0.

Exigences

Ce package nécessite l'outil graphviz .

Vous pouvez installer Graphviz sur MacOS via homebrew :

brew install graphviz

Ou, si vous utilisez Homestead :

sudo apt-get install graphviz

Pour installer Graphviz sur Windows, téléchargez-le depuis le site officiel.

Installation

Vous pouvez installer le package via composer :

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

Si vous utilisez Laravel 5.5+, le package enregistrera automatiquement le fournisseur de services pour vous.

Si vous utilisez Lumen, vous devrez ajouter ce qui suit à bootstrapapp.php :

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

Usage

Par défaut, le package détectera automatiquement tous les modèles de votre répertoire app/Models qui étendent la classe Eloquent Model. Si vous souhaitez définir explicitement l'emplacement de vos modèles, vous pouvez publier le fichier de configuration à l'aide de la commande suivante.

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

Si vous utilisez Lumen et que vous souhaitez personnaliser la configuration, vous devrez copier le fichier de configuration depuis le répertoire du fournisseur :

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

Génération de diagrammes

Vous pouvez générer des diagrammes de relations d'entités à l'aide de la commande artisanale fournie :

php artisan generate:erd

Cela générera un fichier appelé graph.png .

Vous pouvez également spécifier un nom de fichier personnalisé :

php artisan generate:erd output.png

Ou utilisez l'un des autres formats de sortie, comme SVG :

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

Personnalisation

Veuillez jeter un œil au fichier de configuration erd-generator.php publié pour toutes les options de personnalisation disponibles.

Exemples

Voici quelques exemples tirés de la base de code Laravel.io.

Essai

composer test

Journal des modifications

Veuillez consulter CHANGELOG pour plus d'informations sur ce qui a changé récemment.

Contribuer

Veuillez consulter CONTRIBUER pour plus de détails.

Sécurité

Si vous découvrez des problèmes liés à la sécurité, veuillez envoyer un e-mail à [email protected] au lieu d'utiliser le suivi des problèmes.

Crédits

• Marcel Pociot
• Tous les contributeurs

Licence

La licence MIT (MIT). Veuillez consulter le fichier de licence pour plus d'informations.