cookiemc337 / laravel-er-diagram-generator
从您的 Laravel 模型生成 ER 图。
Requires
- php: ^7.1|^8.0
- 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
This package is auto-updated.
Last update: 2024-09-27 17:44:42 UTC
README
此包允许您通过检查模型文件中定义的关系来生成实体关系图。它高度可定制。在幕后，它使用 GraphViz 来生成图表。
如果您想学习如何自己创建可重用的 PHP 包，请查看我的即将推出的 PHP 包开发 视频课程。
先决条件
最低要求的 PHP 版本是 7.1.0。
需求
此包需要 graphviz 工具。
您可以在 MacOS 上通过 homebrew 安装 Graphviz
brew install graphviz
或者，如果您正在使用 Homestead
sudo apt-get install graphviz
要安装 Windows 上的 Graphviz，请从 官方网站 下载。
安装
您可以通过 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
更新日志
有关最近更改的更多信息，请参阅 更新日志。
贡献
请参阅 贡献 以获取详细信息。
安全
如果您发现任何与安全相关的问题，请通过电子邮件发送到 marcel@beyondco.de 而不是使用问题跟踪器。
鸣谢
许可
MIT 许可证 (MIT)。有关更多信息，请参阅 许可文件。