Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
123 lines (91 sloc) 3.39 KB
php2yuml : PHP5 UML Diagrams Generator
Latest version is available on github at :
Documentation can be found on :
This Code is released under the GNU LGPL
Please do not change the header of the file(s).
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
See the GNU Lesser General Public License for more details.
This Script Reverse engineer your PHP5 Code and generates
UML Class Diagrams (
Since It is a Command Line Script, it could be easily used in continuous
integration tools to generate an automatic documentation.
- Classes
- Interfaces
- Property Visibily
- Method Visibility
- Generalization, Specification
- Dependencies.
- size
- direction
Get the script
git clone git://
How can I use it ?
The usage of the script is pretty simple, it takes one mandatory parameter which
is the source file directory, this is where your files are placed.
For example, if your files are placed in the test folder, type :
$ php php2yuml test
Specify an output File
By Default, the Script will output the Image directly (this could be useful to directly
dump the image in a browser.). However, you can use the -o (or the --output) Option to
specify a destination file.
$ php php2yuml -f test -o diagram.png
Specify a diagram Size
Use the -s (--size) to Specify a size:
$ php php2yuml -f test -o diagram.png -s 120
Specify a diagram direction
Use the -d (--direction) to Specify the direction of your diagram.
Options are :
- LR: Left to Right
- TB: Top to Bottom
- RL: Right to Left
$ php php2yuml -f test -o diagram.png -d BT
Specify an autoload Folder
You can use the --a / -- autoload option to add your dependencies.
Showing the Help
use the -h (--help) option to show the Help
$ pgp php2yuml -h
Shows :
php php2yuml -a <autoloadDirectory> -f <SourceDirectory> [-o <file>] [-s <size>] [-d <direction>]
-a, --autoload : Autoload Directory
-f, --from-directory : Source Directory
-o, --output : Dump in an output File (a yuml image)
-s, --size : A size, Default size :100;
-d, --direction : The Direction (Orientation) of the diagram, One
From the following :
- LR (Left to Right)
- TB (Top to Bottom)
- RL (Right to Left)
-h, --help : Displays the Help Message
Something went wrong with that request. Please try again.