laravel er diagram generator

Laravel ER 图生成器

该包允许您通过检查模型文件中定义的关系来生成实体关系图。它是高度可定制的。在幕后，它使用 GraphViz 生成图表。

如果您想学习如何自己创建可重用的 PHP 包，请观看我即将推出的 PHP 包开发视频课程。

先决条件

所需的最低 PHP 版本是 7.1.0。

要求

该软件包需要graphviz工具。

您可以通过自制程序在 MacOS 上安装 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，则需要将以下内容添加到bootstrapapp.php ：

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

用法

默认情况下，该包将自动检测app/Models目录中扩展 Eloquent Model 类的所有模型。如果您希望明确定义模型所在的位置，可以使用以下命令发布配置文件。

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

变更日志

请参阅变更日志以了解最近更改的更多信息。

贡献

详细信息请参阅贡献。

安全

如果您发现任何与安全相关的问题，请发送电子邮件至 [email protected]，而不是使用问题跟踪器。

制作人员

• 马塞尔·波西奥特
• 所有贡献者

执照

麻省理工学院许可证 (MIT)。请参阅许可证文件以获取更多信息。