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目录中扩展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报告，而不是使用问题跟踪器。

致谢

• Marcel Pociot
• 所有贡献者

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。