Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidfuhr/php-plantumlwriter
Create UML diagrams from your PHP source.
https://github.com/davidfuhr/php-plantumlwriter
Last synced: 7 days ago
JSON representation
Create UML diagrams from your PHP source.
- Host: GitHub
- URL: https://github.com/davidfuhr/php-plantumlwriter
- Owner: davidfuhr
- License: bsd-3-clause
- Created: 2013-05-16T13:33:21.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-02-01T21:49:27.000Z (almost 7 years ago)
- Last Synced: 2024-09-22T09:15:49.214Z (about 2 months ago)
- Language: PHP
- Homepage:
- Size: 170 KB
- Stars: 92
- Watchers: 6
- Forks: 24
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
php-plantumlwriter
==================
[](https://travis-ci.org/davidfuhr/php-plantumlwriter) [](https://scrutinizer-ci.com/g/davidfuhr/php-plantumlwriter/?branch=master) [](https://insight.sensiolabs.com/projects/ec51fd8d-6505-45ec-af41-7cb70ce1d89c) [](https://packagist.org/packages/davidfuhr/php-plantumlwriter)
Description
-----------
A tool to create [PlantUML](http://plantuml.sourceforge.net/) class diagrams from your PHP source.
Currently the following language features are supported:
- Property and method visibility
- Static properties and methods
- Method return types from doc comment
- Parameter types from type hinting and doc comment
- Parameter default values
- Class constants with value
- Property types from doc comment
- Property default values
- Implemented interfaces and parent classes
- Abstract classes
Requirements
------------
To generate the PlantUML code a decent version of PHP will suffice. And you need Composer to install the dependencies:
- Composer (http://getcomposer.org/)
But for image generation you need:
- Java Runtime
- `plantuml.jar` (http://plantuml.sourceforge.net/)
### Phar generation
php-plantumlwriter uses [Box 2 library](https://box-project.github.io/box2/) to generate a single .phar file containing everything required for the usage.
To create the .phar file from sources just run:
```
$ box build
```
Usage
-----
To generate the PlantUML code for `WriteCommand.php` run
php bin/php-plantumlwriter write src/Flagbit/Plantuml/Command/WriteCommand.php > WriteCommand.puml
which will output
@startuml
class Flagbit.Plantuml.Command.WriteCommand {
#configure()
#execute(input: Symfony.Component.Console.Input.InputInterface, output: Symfony.Component.Console.Output.OutputInterface)
}
class Flagbit.Plantuml.Command.WriteCommand extends Symfony.Component.Console.Command.Command
@enduml
Now you can convert your `puml` file to a `png` file.:
java -jar plantuml.jar WriteCommand.puml
The resulting png should look like this:
If you have a large class with lots of methods you can suppress method printing using the `--without-methods` flag:
php bin/php-plantumlwriter write --without-methods path/to/your/LargeClass.php
Other available options are `--without-properties` and `--without-constants`.
You can also generate a whole directory at once:
php bin/php-plantumlwriter write path/to/directory
Or multiple files or directories:
php bin/php-plantumlwriter write path/to/ClassOne.php path/to/ClassTwo.php path/to/directory
Known Issues
------------
- Imported classes are currently not handled correctly if read from doc comment
(use-Statement is not fully evaluated) which affects return values and property
types. `use Namespace\B` will be evaluated and expanded but `use Namespace\B as C`
is not yet de-aliased.
- The Namespace Seperator is "." and not "\".
- Traits are not yet supported. See [#4](https://github.com/davidfuhr/php-plantumlwriter/issues/4)
Future Plans
------------
- Add support for class relations, maybe with quantifiers. This could be parsed from
the doc comments. We could also guess the foreign quantifier (`@var OtherClass` as
"*..1" and `@var OtherClass[]` as "*..*"), but we can't determine our quantifier.
If doctrine annotations are present we can use them.
- Evaluate Implementation of Visitor Pattern
- Implement own set of Interfaces
Alternatives
------------
- http://westhoffswelt.de/projects/phuml.html