Search by

emmanuelballery / eb-plantumlbundle

emmanuelballery

This package is abandoned and no longer maintained. No replacement package was suggested.

EBPlantUMLBundle

This package's canonical repository appears to be gone and the package has been frozen as a result. Email us for help if needed.

Package info

github.com/emmanuelballery/EBPlantUMLBundle

Homepage

Type:symfony-bundle

pkg:composer/emmanuelballery/eb-plantumlbundle

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 6 173

Dependents: 0

Suggesters: 0

Stars: 5

1.0.0-beta.3 2019-11-26 07:38 UTC

Requires

Requires (Dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT af485a33c0902dc201c2b0dbcbf839b03bc1155f

  • Emmanuel BALLERY <emmanuel.ballery.woop@gmail.com>

Published on Packagist.org on 2019-11-26 07:40 UTC

This package is auto-updated.

Last update: 2020-08-26 09:05:34 UTC

README

This is a POC bundle for PlantUML : http://plantuml.sourceforge.net/.

composer require --dev symfony/process emmanuelballery/eb-plantumlbundle

Format support

TXT files or URLs can be generated without PlantUML dependencies installed locally.

If needed, you can also use http://www.plantuml.com/plantuml/uml/ to render the PNG image from the TXT file.

Direct conversion to PNG/SVG/ATXT/UTXT files is only supported if all PlantUML requirements are met:

  • Some Java JDK (for example sudo apt install -y default-jdk)
  • DOT Graphiz (for example sudo apt install -y graphviz)

Generate Doctrine UML graph

# TXT file
php app/console eb:uml:doctrine doctrine.txt
php app/console eb:uml:doctrine --format=txt > doctrine.txt

# PNG file
php app/console eb:uml:doctrine doctrine.png
php app/console eb:uml:doctrine --format=png > doctrine.png

# SVG file
php app/console eb:uml:doctrine doctrine.svg
php app/console eb:uml:doctrine --format=svg > doctrine.svg

# ASCII files (atxt or utxt)
php app/console eb:uml:doctrine doctrine.atxt
php app/console eb:uml:doctrine --format=atxt > doctrine.atxt
php app/console eb:uml:doctrine doctrine.utxt
php app/console eb:uml:doctrine --format=utxt > doctrine.utxt

# UML
php app/console eb:uml:doctrine --format=uml

Generate Twig inheritance tree

Use -i to include templates having their path matching your expression:

  • -i ProjectBundle: include every paths containing "ProjectBundle"
  • -i app/Resources/views: include every paths containing "app/Resources/views"

Use -e to exclude templates having their path matching your expression:

  • -e ExcludedBundle: exclude every paths containing "ExcludedBundle"
# TXT file
php app/console eb:uml:twig twig.txt -i AppBundle
php app/console eb:uml:twig -i AppBundle > twig.txt

# PNG file
php app/console eb:uml:twig twig.png -i AppBundle
php app/console eb:uml:twig -i AppBundle --format=png > twig.png

# SVG file
php app/console eb:uml:twig twig.svg -i AppBundle
php app/console eb:uml:twig -i AppBundle --format=svg > twig.svg

# ASCII files (atxt or utxt)
php app/console eb:uml:twig twig.atxt -i AppBundle
php app/console eb:uml:twig -i AppBundle --format=atxt > twig.atxt
php app/console eb:uml:twig twig.utxt -i AppBundle
php app/console eb:uml:twig -i AppBundle --format=utxt > twig.utxt

# URL
php app/console eb:uml:twig -i AppBundle --format=uml

Generate validation chart

# TXT file
php app/console eb:uml:validator validator.txt
php app/console eb:uml:validator > validator.txt

# PNG file
php app/console eb:uml:validator validator.png
php app/console eb:uml:validator --format=png > validator.png

# SVG file
php app/console eb:uml:validator validator.svg
php app/console eb:uml:validator --format=svg > validator.svg

# ASCII files (atxt or utxt)
php app/console eb:uml:validator validator.atxt
php app/console eb:uml:validator --format=atxt > validator.atxt
php app/console eb:uml:validator validator.utxt
php app/console eb:uml:validator --format=utxt > validator.utxt

# URL
php app/console eb:uml:validator --format=uml