cierrateam / laravel-er-diagram-generator
从您的Laravel模型生成ER图。
Requires
- php: ^7.1|^8.0
- doctrine/dbal: ~2.3|^3.3
- nikic/php-parser: ^2.0|^3.0|^4.0
- phpdocumentor/graphviz: ^1.0
Requires (Dev)
- larapack/dd: ^1.0
- orchestra/testbench: ~3.5|~3.6|~3.7|~3.8|^4.0|^7.0
- phpunit/phpunit: ^7.0| ^8.0|^9.5.10
- spatie/phpunit-snapshot-assertions: ^1.3|^4.2
This package is auto-updated.
Last update: 2024-09-09 14:03:55 UTC
README
本包允许您通过检查模型文件中定义的关系来生成实体关系图。它具有高度的可定制性。在幕后，它使用GraphViz来生成图形。
如果您想学习如何自己创建可重用的PHP包，请查看我即将推出的PHP Package Development视频课程。
先决条件
最低要求的PHP版本是7.1.0 - 兼容PHP 8.0
需求
此包需要graphviz工具。
您可以在MacOS上通过homebrew安装Graphviz
brew install graphviz
或者，如果您使用Homestead
sudo apt-get install graphviz
要安装Graphviz在Windows上，从官方网站下载。
安装
您可以通过composer安装此包
composer require cierrateam/laravel-er-diagram-generator --dev
如果您使用Laravel 5.5+，则包会自动为您注册服务提供者。
如果您使用Lumen，您需要在bootstrap\app.php中添加以下内容
\\ Register Service Providers $app->register(Cierra\ErdGenerator\ErdGeneratorServiceProvider::class);
用法
默认情况下，该包会自动检测您的app目录中所有扩展Eloquent模型类的模型。如果您想明确指定模型的存放位置，可以使用以下命令发布配置文件。
php artisan vendor:publish --provider=Cierra\\ErdGenerator\\ErdGeneratorServiceProvider
如果您使用Lumen并想自定义配置，您需要从vendor目录复制配置文件
cp ./vendor/cierrateam/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
更新日志
请参阅更新日志以获取有关最近更改的更多信息。
贡献
请参阅贡献指南以获取详细信息。
安全
如果您发现任何与安全相关的问题，请通过vittorio@cierra.de发送电子邮件，而不是使用问题跟踪器。
鸣谢
- Marcel Pociot
- Vittorio Emmermann for forking
- 所有贡献者
许可协议
MIT许可协议（MIT）。有关更多信息，请参阅许可文件。