README

这是一个 CakePHP 插件，它会在你的 CakePHP 应用程序和插件中找到所有的表，确定它们之间的关系，并为你构建一个漂亮的图形，直观地展示这些关系。

注意：此分支适用于 CakePHP 4.2+。有关详细信息，请参阅版本映射。

要求

此脚本依赖于 phpDocumentor/Graphviz 包，而不是直接依赖于命令行的 dot 工具。为了获得图形结果而不是纯文本信息，你需要安装 Graphviz 命令行工具，包括 dot。

如果在 Windows 上，请确保在配置键 GraphViz.path 中设置路径。

// config/app.php
'GraphViz' => [
	'path' => 'C:\...\graphviz\bin\\',
],

您可以使用 composer 将此插件安装到您的 CakePHP 应用程序中

composer require --dev dereuromark/cakephp-model-graph:dev-master

注意：此插件不适用于生产环境，所以请确保使用 --dev 标志，并将其安装为仅开发工具。

不要忘记在 Application.php 中的 bootstrap 函数下加载它

$this->addPlugin('ModelGraph');

使用此脚本的简单方法是直接通过 CakePHP 控制台运行它

$ bin/cake model_graph

它应该在您的 TMP 目录中生成一个 graph.png 图像。请查看。

如果您需要更多控制，该 shell 从命令行理解两个选项：文件名和格式。您可以使用文件名选项，如下所示

$ bin/cake model_graph /tmp/relations.dot

如果可能，它将根据扩展名推断格式。

您也可以手动提供格式

$ bin/cake model_graph -f svg

对于文件名，没有进行特殊处理。您提供的即是您得到的。至于格式，您可以使用 Graphviz 支持并理解的任何格式。

如果您仍然需要更多控制，请查看脚本内部。有许多设置、选项、参数和注释，供您理解。了解 GraphViz Dot 语言可能会有所帮助，这样您会更有信心。

如果您首先渲染了 dot 文件，可以使用 render 命令将其转换为图像

$ bin/cake model_graph render /tmp/relations.dot /tmp/relations.svg

享受！