class Generator extends Alvine

Generator für PlantUML-Diagramme

Dieser Klasse erstellt aus Quelltexte passende Beschreibungen für plantuml.

Klassendiagramm

Der folgende Aufruf durchsucht das Verzeichnis /opt/php/src/ nach PHP-Dateien und erstellt aus diesen ein Klassendiagramm mit Relationen

$g = new \Alvine\Documentation\PlantUML\Generator(new \Alvine\IO\File\Directory('/opt/php/src/'));
echo (string)$g->getClassDiagram();

Constants

STATISTIC_DIRECTORY

Verzeichnisse

STATISTIC_PHP

PHP-Dateien

STATISTIC_NONPHP

Keine PHP-Dateien

GLOBAL_NAMESPACE

Globaler Namespace

Properties

protected Directory $directory
protected Structure $structure
protected string> $statistics

Methods

__construct(Directory $directory)

Neuen Generator für ein Verzeichnis erstellen

string
getNameFromReflection(Representation $class)

Namensraum einer Klasse ermitteln

updateStatistic(mixed $key)

Aktualisiert die Statistik

parse()

Verzeichnis auslesen und Dateien parsen

string
getClassDiagram()

Klassendiagramm

Details

at line 94
__construct(Directory $directory)

Neuen Generator für ein Verzeichnis erstellen

Parameters

Directory $directory Verzeichnis

at line 111
protected string getNameFromReflection(Representation $class)

Namensraum einer Klasse ermitteln

Parameters

Representation $class Klasse

Return Value

string Namensraum

at line 122
protected Generator updateStatistic(mixed $key)

Aktualisiert die Statistik

Parameters

mixed $key Key

Return Value

Generator

at line 135
protected Generator parse()

Verzeichnis auslesen und Dateien parsen

Return Value

Generator

at line 174
string getClassDiagram()

Klassendiagramm

Erstellt aus den ausgelesenen PHP-Dateien eine Beschreibung eines Klassendiagrammes für plantUML.

Return Value

string plantUML Beschreibung