7dir/laravel-er-diagram-generator6

从您的Laravel模型中生成ER图。

1.4.7 2019-09-29 16:44 UTC

This package is auto-updated.

Last update: 2024-09-19 06:05:28 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

此包允许您通过检查模型文件中定义的关系来生成实体关系图。它具有高度可定制性。在幕后,它使用GraphViz生成图形。

如果您想了解如何自己创建可重用的PHP包,请查看我即将推出的PHP包开发视频课程。

先决条件

所需的最小PHP版本是7.1.0。

要求

此包需要graphviz工具。

您可以通过homebrew在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,您需要在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代码库中提取的示例。

Using Database Schema

Customized

测试

composer test

变更日志

有关最近更改的更多信息,请参阅CHANGELOG

贡献

有关详细信息,请参阅CONTRIBUTING

安全

如果您发现任何与安全相关的问题,请通过marcel@beyondco.de发送电子邮件,而不是使用问题跟踪器。

鸣谢

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件