mike4git/umlgeneration-bundle

UML 生成包

v1.1.3 2023-08-11 06:39 UTC

This package is auto-updated.

Last update: 2024-09-11 09:09:41 UTC


README

根据您的类定义生成 UML 类图等

设置

  • 复制 env.dist 并用您的 ID 替换 USER_ID(在终端中检索:echo $(id -u)

安装

在您可以使用此包之前,您需要将 git 仓库添加到您的 composer.json 中

composer require "mike4git/umlgeneration-bundle"

并将其添加到您的 bundles.php 中

<?php declare(strict_types=1);

return [
    // mostly dev environment is enough
    \UMLGenerationBundle\UMLGenerationBundle::class => ['dev' => true],
];

此外,您还需要安装 GraphViz(dot 可执行文件)。基于 Debian/Ubuntu 的发行版用户可以简单地执行

$ sudo apt-get install graphviz

Windows 用户需要下载 GraphViZ for Windows,其余用户应从GraphViz 主页安装。

使用以下 URL 进行 GraphViz 使用:GraphViz

使用方法

生成 dot 文件

$ php bin/console uml:generate -o myDotfileName

请注意,这将生成一个名为 myDotfileName.dot 的文件

生成图形

$ dot -Tsvg myDotfileName.dot -o image.svg

之后,您应该看到类似以下内容

Sample UML class diagram

完成。