Skip to content
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
src/YumlPhp
tests
.gitignore
.php_cs
.scrutinizer.yml
.travis.yml
LICENSE
README.md
box.json
composer.json
phpunit.xml.dist

README.md

YumlPhp

a php adapater for http://yuml.me

Scrutinizer Code Quality SensioLabsInsight Build status... Code Coverage Latest Stable Version Total Downloads License StyleCI

Installation

Installation with composer

"require" : {
    "digitalkaoz/yuml-php":  "@stable",
    "andrewsville/php-token-reflection":    "dev-develop@dev"
},
"repositories" : [
    {
        "type" : "vcs",
        "url" : "https://github.com/digitalkaoz/PHP-Token-Reflection"
    }
],

You need to add my custom PHP-Token-Reflection Fork, since it has some unmerged but needed improvements!

Installation with PHAR

wget http://digitalkaoz.github.io/yuml-php/yuml-php.phar

Usage

the classes command generates a class diagram from all classes in the given folder

Usage:
    classes [--console] [--debug] [--properties] [--methods] [--filter] folder

Arguments:
    folder      the folder to scan for classes

Options:
    --console     log to console
    --debug       debug
    --properties  build with properties
    --methods     build with methods
    --filter      to include/exclude files/folder
yuml-php classes src/

Class Diagram

the activity command generates an activity diagram from a given file

Usage:
    activity [--console] [--debug] file

Arguments:
    file          the file to read

Options:
    --console     log to console
    --debug       debug
yuml-php activity activities.txt

Activity Diagramm

the use-case command generates a use-case diagram from a given file

Usage:
    use-case [--console] [--debug] file

Arguments:
    file          the file to read

Options:
    --console     log to console
    --debug       debug
yuml-php use-case use-cases.txt

Use-Case Diagramm

Building the PHAR

php vendor/bin/box build

Tests

php bin/vendors.php
phpunit

TODO

You can’t perform that action at this time.