通过 
搜索
搜索beyondcode / laravel-er-diagram-generator
从您的Laravel模型生成ER图。
3.0.0
2024-03-15 17:40 UTC
Requires
- php: ^7.1|^8.0
- doctrine/dbal: ~2.3|^3.3
- nikic/php-parser: ^2.0|^3.0|^4.0|^5.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|^8.0|^9.0
- phpunit/phpunit: ^7.0| ^8.0|^9.5.10
- spatie/phpunit-snapshot-assertions: ^1.3|^4.2
README
此包允许您通过检查模型文件中定义的关系来生成实体关系图。它具有高度可定制性。在幕后，它使用GraphViz生成图形。
如果您想学习如何自己创建可重用的PHP包，请查看我即将推出的PHP Package Development视频课程。
先决条件
所需的最小PHP版本是7.1.0。
需求
此包需要graphviz工具。
您可以在MacOS上通过homebrew安装Graphviz
brew install graphviz
或者，如果您使用的是Homestead
sudo apt-get install graphviz
要安装Graphviz在Windows上，可以从官方网站下载。
安装
您可以通过composer安装此包
composer require beyondcode/laravel-er-diagram-generator --dev
如果您使用Laravel 5.5+，则包将自动为您注册服务提供者。
如果您使用Lumen，则需要将以下内容添加到bootstrap\app.php
# Register Service Providers $app->register(BeyondCode\ErdGenerator\ErdGeneratorServiceProvider::class);
用法
默认情况下，此包将自动检测您的app/Models目录中扩展Eloquent模型类的所有模型。如果您想显式定义模型的位置，可以使用以下命令发布配置文件。
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以获取有关最近更改的更多信息。
贡献
请参阅CONTRIBUTING以获取详细信息。
安全
如果您发现任何安全问题，请通过电子邮件marcel@beyondco.de报告，而不是使用问题跟踪器。
鸣谢
许可证
MIT许可证（MIT）。请参阅许可证文件以获取更多信息。