yuml-php
Fork me on GitHub

A PHP Adapater for YUML.me

build various UML Diagrams from your Source-Code in No-Time

$ php yuml-php.phar classes src/

you get an Image Url to the Rendered Diagram (or PDF or an Editable Link)

Installation

Installation as PHAR Archive

#1Download the Phar here

#2 Use it

$ php yuml-php.phar

Installation with Composer

#1 define yuml-php in your composer.json

{
    "require" : {
        "digitalkaoz/yuml-php" : "@stable"
    }
}

#2 Use it

$ php composer.phar update

Installation from Source

#1 Clone the Github Repository

$ git clone git://github.com/digitalkaoz/yuml-php.git
$ cd yuml-php

#2 Install Dependencies with Composer

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar install

#3 Use it

$ bin/yuml-php

Installation as Symfony Bundle

The Symfony2 Bundle is not available yet.

Usage

Building a Class Diagram

The Class Diagram Builder lets you build UML Class Diagrams from your PHP Source Files.

Available Options


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 folder/files

Examples


$ php yuml-php.phar classes src/
$ php yuml-php.phar classes --methods src/
$ php yuml-php.phar classes --properties src/
$ php yuml-php.phar classes --debug src/
$ php yuml-php.phar classes --filter=\!/Test --filter=/Include src/
$ php yuml-php.phar classes --style="scruffy;dir:TB;scale:80;" src/

Building an Activity Diagram

The Activity Diagram Builder lets you build a UML Activity Diagram from a file.

Available Options


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

Arguments:
file the file to read

Options:
--console log to console
--debug debug

Examples


$ php yuml-php.phar activity activity.txt
$ php yuml-php.phar activity --debug activity.txt
$ php yuml-php.phar activity --style="scruffy;dir:TB;scale:80;" activity.txt

Building a Use-Case Diagram

The Use-Case Diagram Builder lets you build a UML Use-Case Diagram from a file.

Available Options


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

Arguments:
file the file to read

Options:
--console log to console
--debug debug

Examples


$ php yuml-php.phar use-case usecase.txt
$ php yuml-php.phar use-case --debug usecase.txt
$ php yuml-php.phar use-case --style="scruffy;dir:TB;scale:80;" usecase.txt

Development

Github

all Development is happening at Github. So open your tickets or pull requests there.

Running Tests

Install yuml-php and all its dependencies (read)

$ phpunit

Travis CI Build status...