class Component extends Component

PlantUML-Komponente

Die Komponentenklasse stellt Methoden zur Verfügung, um Informationen der plantUML-Komponente zu erhalten. Für den Zugriff auf eine Komponente muss die Instanz über getInstance() geholt werden.

$component = \Alvine\Documentation\PlantUML\Component::getInstance();

Der Zugriff auf die Komponenten-Konfiguration erfolgt direkt über die Eigenschaften.

$component = \Alvine\Documentation\PlantUML\Component::getInstance();
// Projektspezifische Konfiguration einlesen
$component->getConfiguration(\Alvine\IO\File\File('config.properties'));

Um Projektspezifische Konfigurationen zu verwenden, können die Konfigurations- werte überschrieben werden. Dies kann entweder über eine Datei oder ein Property-Objekt erfolgen.

$component = \Alvine\Documentation\PlantUML\Component::getInstance();

// Projektspezifische Konfiguration einlesen
$component->loadCustomConfiguration(\Alvine\IO\File\File('config.properties'));

// Alternativ über ein Property-Objekt
$property = new \Alvine\Types\Properties();
$property->setValue('a.b.c', 'value1');
$property->setValue('a.b.d', 'value2');
$component->updateConfiguration($property);

Methods

Directory
getBasePath()

Pfad der Klasse

Details

at line 75
protected Directory getBasePath()

Pfad der Klasse

Return Value

Directory Pfad der Klasse