phuml/phuml

phUML is a fully automatic UML class diagram generator for PHP code

6.1.0 2022-06-20 17:05 UTC

Requires

• php: ^8.1
• ext-tokenizer: *
• league/pipeline: ~1.0.0
• nikic/php-parser: ~4.13.2
• phpdocumentor/reflection-docblock: ~5.3.0
• phpdocumentor/type-resolver: ~1.6.1
• symfony/console: ~6.0.7
• symfony/finder: ~6.0.3
• symfony/process: ~6.0.7
• symplify/smart-file-system: ~10.2.2
• twig/twig: ~3.3.10
• webmozart/assert: ~1.10.0

Requires (Dev)

• ext-imagick: *
• ergebnis/composer-normalize: ~2.25.2
• friendsofphp/php-cs-fixer: ~3.8.0
• infection/infection: ~0.26.8
• lupka/phpunit-compare-images: ~1.0.0
• maglnet/composer-require-checker: ~4.0.0
• phpro/grumphp: ~1.11.0
• phpspec/prophecy-phpunit: ~2.0.1
• phpstan/extension-installer: ~1.1.0
• phpstan/phpstan: ~1.5.7
• phpstan/phpstan-strict-rules: ~1.1.0
• phpstan/phpstan-webmozart-assert: ~1.1.2
• phpunit/phpunit: ~9.5.20
• pyrech/composer-changelogs: ~1.8.1
• rector/rector: ~0.12.21

BSD-3-Clause

• Luis Montealegre

• uml

README

phUML is a fully automatic UML class diagram generator written in PHP. It creates a class diagram from an Object-Oriented codebase based on the UML specification.

Installation

Phive

phUML can be installed by Phive - The PHAR Installation and Verification Environment.

phive install phuml

Docker

The official phUML Docker image can be found on Docker Hub.

docker pull montealegreluis/phuml

Here's the list of all the available Docker image tags

Composer

phUML can be installed globally by Composer.

composer global require phuml/phuml

Alternatively, you may want to install phUML as well as its dependencies.

composer require phuml/phuml

How does it look like?

The image shown here, is the class diagram generated by phUML when it's run against its original codebase.

Documentation

For more details visit the documentation page

Contribute

Please refer to CONTRIBUTING for information on how to contribute to phUML.

License

Released under the BSD-3-Clause.

Credits

This code is principally developed and maintained by Luis Montealegre.

This library was created by Jakob Westhoff.

Special thanks to all of these awesome contributors.