mike4git/umlgeneration-bundle

UML Generation Bundle

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

Requires

• php: ~8.0.0 || ~8.1.0 || ~8.2.0
• pimcore/pimcore: ^10.0 || ^11.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.8
• jangregor/phpstan-prophecy: ^1.0
• phpspec/prophecy: ^1.11
• phpspec/prophecy-phpunit: ^2.0
• phpstan/extension-installer: ^1.1
• phpunit/phpunit: ^9.5

GPL-3.0-or-later

• Michael Albrecht

README

generates UML class diagrams and more based upon your class definitions

Setup

• copy env.dist and replace USER_ID with own ID (Retrieve: echo $(id -u) in a terminal)

Install

Before you can use the Bundle, you need to add the git repository to your composer.json

composer require "mike4git/umlgeneration-bundle"

and add it to your bundles.php:

<?php declare(strict_types=1);

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

Additionally, you'll have to install GraphViz (dot executable). Users of Debian/Ubuntu-based distributions may simply invoke:

$ sudo apt-get install graphviz

Windows users have to download GraphViZ for Windows and remaining users should install from GraphViz homepage.

Use the following URL for the GraphViz usage: GraphViz

Usage

Generate dotfile:

$ php bin/console uml:generate -o myDotfileName

Note that this will generate a myDotfileName.dot file

Generate Graph:

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

After that you should see something like this:

Done.