Overview

Namespaces

  • Alvine
    • Documentation
      • PlantUML
        • Diagram
          • Classes
            • Relation
            • Structure

Classes

  • Component
  • Generator
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated

Class Generator

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();
Alvine\Core\Alvine
Extended by Alvine\Documentation\PlantUML\Generator
Namespace: Alvine\Documentation\PlantUML
Package: Alvine\Documentation\PlantUML
Category: Alvine
License: Alvine Nutzungslizenz
Author: schukai GmbH info@schukai.de
Version: $Revision:$
Since: 20140618
Link: alvine.io
Link: Klassendiagramm (Wikipedia)
Link: PlantUML Dokumentation
Located at Generator.class.php
Methods summary
public
# __construct( Alvine\IO\File\Directory $directory )

Neuen Generator für ein Verzeichnis erstellen

Neuen Generator für ein Verzeichnis erstellen

Parameters

$directory
Verzeichnis
protected string
# getNameFromReflection( Alvine\Development\Upkeep\Representation $class )

Namensraum einer Klasse ermitteln

Namensraum einer Klasse ermitteln

Parameters

$class
Klasse

Returns

string
Namensraum
protected Alvine\Documentation\PlantUML\Generator
# updateStatistic( mixed $key )

Aktualisiert die Statistik

Aktualisiert die Statistik

Parameters

$key
Key

Returns

Alvine\Documentation\PlantUML\Generator
protected Alvine\Documentation\PlantUML\Generator
# parse( )

parse

parse

Verzeichnis auslesen und Dateien parsen

Returns

Alvine\Documentation\PlantUML\Generator
public string
# getClassDiagram( )

Klassendiagramm

Klassendiagramm

Erstellt aus den ausgelesenen PHP-Dateien eine Beschreibung eines Klassendiagrammes für p lantU ML.

Returns

string
plantUML Beschreibung
Constants summary
string STATISTIC_DIRECTORY

Verzeichnisse

Verzeichnisse

# 'directory'
string STATISTIC_PHP

PHP-Dateien

PHP-Dateien

# 'php'
string STATISTIC_NONPHP

Keine PHP-Dateien

Keine PHP-Dateien

# 'nonphp'
string GLOBAL_NAMESPACE

Globaler Namespace

Globaler Namespace

# 'global'
Properties summary
protected Alvine\IO\File\Directory $directory

Verzeichnis

Verzeichnis

#
protected Alvine\Documentation\PlantUML\Diagram\Classes\Structure $structure

Struktur

Struktur

#
protected array<\string> $statistics

Dateistatistik

Dateistatistik

#
alvine.documentation.plantuml API-Dokumentation 0.11 | © schukai GmbH | Impressum