class Component extends Component

Die Komponentenklasse stellt Methoden zur Verfügung, um Informationen der Jenkins-Komponente zu erhalten.

Für den Zugriff auf eine Komponente muss die Instanz über getInstance() geholt werden.

$component = \Alvine\Framework\Component::getInstance();

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

$component = \Alvine\Framework\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\Framework\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);

Traits

Singlton-Implementierung
SerializableImplementation

Constants

VERSION

Generelle Alvine-Version

APIVERSION

Version der API-Version der Klasse.

IDENTIFICATION

Identifizierung der Alvine API

SERIALVERSION

Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren.

REQUIRED_PHP_VERSION

Anforderungen und Grenzwerte an das System PHP-Version des Interpreters

VERSION_STABLE

Stabil

VERSION_SNAPSHOT

Standardversion

VERSION_APLPHA

Entwicklungsversion

VERSION_BETA

Beta-Version

VERSION_RC

Release Candidate

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
static protected array $instances from SingletonImplementation
protected Properties $configuration from Component
protected null|string $version from Component
protected string $name from Component
protected Ruleset $ruleset from Component

Methods

string
serialize()

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

bool
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

bool
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

void
unserialize(string $serialized)

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

string
__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

from Alvine
void
__set(string $name, mixed $value)

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

from Alvine
boolean
__isset(string $name)

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

from Alvine
__unset(string $name)

Zurücksetzen von Werten

from Alvine
mixed
__get(string $name)

Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.

from Alvine
getClosure(string $name)

Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.

from Alvine
boolean
propertyExists(string $name)

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

from Alvine
mixed
__call(string $name, array $arguments)

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

from Alvine
boolean
isCallable(type $name)

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

from Alvine
string
getHashCode() deprecated

Die Methode Alvine::getID() verwenden!

from Alvine
string
getID()

Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.

from Alvine
string
getShortID(int|null $length = null)

Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.

from Alvine
boolean
equals(Alvine $object)

Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von Alvine::getID() zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.

from Alvine
Alvine
getClone(boolean $deepClone = false)

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

from Alvine
__clone()

Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.

from Alvine
string
getClass()

Name der Klasse

from Alvine
boolean
isInstanceOf(object $object)

Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.

from Alvine
static object
getInstance()

Instanz erstellen

__construct()

Komponente

from Component
getBasePath()

Pfad der Klasse

getConfigPath()

Konfigurationsverzeichnis

from Component
getDefaultPath()

Konfigurationsverzeichnis mit Defaults

from Component
getResourcePath()

Ressourcen

from Component
getLocaleMessageFormatter(Locale $locale = null)

Liest die Locale-Texte aus der entsprechenden Property-Datei aus und gibt diese zurück. In dem Beispiel hat die Komponente die folgende Textdatei

from Component
getResourceText(Locale $locale = null)

No description

from Component
string|null
getVersion()

Version in der Form major.minor.build ausgeben.

from Component
string
getName()

Name der Komponent

from Component
updateConfiguration(Properties $properties)

Eigenschaften setzen

from Component
updateConfigurationFromFile(File $configFile)

Anwendungsspezifische Konfiguration

from Component
getConfiguration()

Konfiguration

from Component
string
getLicense(string $name = null)

Lizenzen

from Component
initEnvironmentRules()

Regeln für die Systemprüfung

from Component
static Collection
checkCompatibility()

Kompatibilität prüfen

from Component
array
getDependencyExceptions()

Führt eine Prüfung aus und gibt alle nicht erfüllten Exceptions zurück

from Component

Details

string serialize()

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

Soll eine abgeleitete Klasse nicht serialisierbar sein, so muss diese Methode überschrieben werden und eine Exception werfen.

Eigenschaften die mit volatile oder associated beginnen werden gesonder behandelt. Eigenschaften mit Prefix volatile werde nicht serialisiert. Bei Eigenschaften mit der Vorsilbe associated wird nur die ID des Objektes serialisiert. Wird in der Eigenschaft kein Objekt gespeichert wird eine TypeException geworfen.

Return Value

string String-Repräsentation des Objektes

bool hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

bool

bool hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

bool

protected checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

Diese Methode überprüft ein Objekt und repariert im idealfall ältere Kopien. Kann eine alte Kopie nicht wieder hergestellt werden, so wird eine Exeption geworfen.

Diese Methode muss von den abgeleiteten Klassen überschrieben werden. In der abgeleiteten Klasse sollte die Parent-Methode aufgerufen werden.

Parameters

array $serialization Daten des serialisiertes Objekts

Exceptions

UnserializeException Keine Übereinstimmung

void unserialize(string $serialized)

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

Parameters

string $serialized

Return Value

void

in Alvine at line 177
string __toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

Return Value

string Daten des Objekts

in Alvine at line 211
void __set(string $name, mixed $value)

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

Diese Methode wird indirekt aufgerufen, sobald ein Wert oder eine Funktion einem Objekt zugeordnet wird, die nicht definiert wurde.

class MyObject extends Alvine {
}

$obj = new MyObject();
$obj->myValue = 4;

Parameters

string $name Name der Eigenschaft
mixed $value Wert der Eigenschaft

Return Value

void

in Alvine at line 222
boolean __isset(string $name)

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

Parameters

string $name

Return Value

boolean

in Alvine at line 231
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 256
mixed __get(string $name)

Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

Exceptions

BadPropertyException

in Alvine at line 281
Closure getClosure(string $name)

Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.

Parameters

string $name Name des Closure

Return Value

Closure

Exceptions

NotFoundException
BadPropertyException

in Alvine at line 307
boolean propertyExists(string $name)

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

string $name Name der Eigenschaft

Return Value

boolean

in Alvine at line 339
mixed __call(string $name, array $arguments)

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

Achtung: Wird das Closure in einem Objekt definiert, so ist die Variable $this nicht das Objekt des Closures, sondern des, in dem das Closure definiert wurde.

// als erster Parameter wird immer das Objekt übergeben
$a->myfunction = function($obj, $b) { echo $b.'!'; };
// Aufruf als Eigenschaft ohne Parameter
$a->myfunction;  // Ausgabe ist ein !
//
// Aufruf als Methode mit Parametern
$a->myfunction('OK');  // Ausgabe ist  OK!

Parameters

string $name Funktionsname
array $arguments Argumente

Return Value

mixed Ergebnis des Callbacks

Exceptions

NotCallableException Exception

in Alvine at line 362
boolean isCallable(type $name)

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}

Parameters

type $name Name der Methode

Return Value

boolean Ergebnis

in Alvine at line 376
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 396
string getID()

Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.

Objekte haben bei der Erstellung noch keine eindeutige ID, erst mit dem expliziten Aufruf der ID wird diese einmalig erstellt und im Objekt gepseichert.

Diese Methode wird implizit beim Serialisieren aufgerufen.

Die UUID ist dabei vom Type4 (Random)

Return Value

string UUID des Objektes

in Alvine at line 416
string getShortID(int|null $length = null)

Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.

Diese Methode ist hilfreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision mit anderen Hash vergleichbarer Objekte.

Parameters

int|null $length

Return Value

string

in Alvine at line 442
boolean equals(Alvine $object)

Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von Alvine::getID() zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.

class MyObject extends Alvine {};

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}

Parameters

Alvine $object Objekt das überprüft werden soll

Return Value

boolean true wenn beide Objekte identisch sind.

in Alvine at line 463
Alvine getClone(boolean $deepClone = false)

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

Wenn eine abgeleitete Klasse diese Methode nicht unterstützt, so muss diese die Methode überschreiben und eine CloneNotSupportedException werfen. Die Standardmethode klont eine seichte Kopie der Eigenschaften. Das bedeutet das Objekte in den Eigenschaften nicht geclont werden. Sollen diese auch geclont werden muss true übergeben werden.

Wenn weitere Funktionen implementiert werden sollen, so muss __clone überschrieben werden

Parameters

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

See also

Alvine::__clone

in Alvine at line 475
__clone()

Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

in Alvine at line 493
string getClass()

Name der Klasse

class MyObject extends Alvine {};
$obj = new MyObject();

echo $obj->getClass();

Return Value

string Klassenname

See also

ClassType::getNormalizedName

in Alvine at line 518
boolean isInstanceOf(object $object)

Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.

if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

Die Prüfung entspricht

$this instanceof $object

Parameters

object $object

Return Value

boolean

static object getInstance()

Instanz erstellen

Erstellt ein neues Objekt. Ist bereits ein Objekt registriert, so wird dieser zurückgegeben.

Return Value

object Neues oder registriertes Objekt

Exceptions

FrameworkException Wenn die Klasse nicht ermittelt werden kann.

in Component at line 139
protected __construct()

Komponente

Es kann keine Instanz direkt erstellt werden. Dazu muss die Factory-Methode verwendet werden. Beim erstellen einer neuen Instanz wird einmalig eine Systemprüfung durchgeführt und im Fehlerfall eine entsprechende Exeption geworfen.

Beim Erstellen der Instanz wird das Regelwerk für die Abhängigkeiten ausgeführt. Dies kann je nach Komponente dazu führen, das Exceptions geworfen werden.

at line 72
protected Directory getBasePath()

Pfad der Klasse

Return Value

Directory Verzeichnis

in Component at line 183
Directory getConfigPath()

Konfigurationsverzeichnis

Return Value

Directory Verzeichnis

in Component at line 192
Directory getDefaultPath()

Konfigurationsverzeichnis mit Defaults

Return Value

Directory Verzeichnis

in Component at line 201
Directory getLicensePath()

Lizenzen

Return Value

Directory Verzeichnis

in Component at line 210
Directory getAssetPath()

Assets

Return Value

Directory Verzeichnis

in Component at line 219
Directory getResourcePath()

Ressourcen

Return Value

Directory Verzeichnis

in Component at line 253
MessageArgumentFormatter getLocaleMessageFormatter(Locale $locale = null)

Liest die Locale-Texte aus der entsprechenden Property-Datei aus und gibt diese zurück. In dem Beispiel hat die Komponente die folgende Textdatei

text=Es gibt {count} Autos
text.ONE=Es gibt {count} Auto

Diese kann über folgenden Programmcode ausgelsen und verarbeitet werden.

// Die Komponenten-Klasse implementiert das Singleton-Pattern und kann nur über getInstance() geladen werden.
$component = \Alvine\Documentation\PlantUML\Component::getInstance();

$localeText = Component::getLocaleText();
$text = new \Alvine\Text\PropertyText($prop, 'text');

// Anzahl n
$map = new Alvine\Types\Map();
$map['n'] = '5'; // n definiert die Mehrzahlregel

echo new \Alvine\Text\Formatter((string) $text, $map, 'n');

Parameters

Locale $locale

Return Value

MessageArgumentFormatter

in Component at line 263
Properties getResourceText(Locale $locale = null)

Parameters

Locale $locale

Return Value

Properties

in Component at line 294
string|null getVersion()

Version in der Form major.minor.build ausgeben.

Ist die Version in der Komponente nicht direkt gesetzt, so wird versucht diese aus dem Dateinamen der Phar-Datei zu ermitteln. Wird keine Version gefunden, so wird null zurückgegeben.

Return Value

string|null

in Component at line 320
string getName()

Name der Komponent

Return Value

string Name der Komponente

in Component at line 339
Component updateConfiguration(Properties $properties)

Eigenschaften setzen

Über diese Methode können Anwendungseigenschaften gesetzt werden, die die entsprechenden Komponenteneigenschaften überschreiben.

Parameters

Properties $properties Neue Eigenschaften

Return Value

Component

in Component at line 359
Component updateConfigurationFromFile(File $configFile)

Anwendungsspezifische Konfiguration

Mit dieser Methode kann eine Konfiguration geladen werden, die Werte der Komponente überschreibt. So ist es möglich in einer Anwendung die Konfigurationswerte zu setzen.

$component = \Alvine\Documentation\mycomponent\Component::getInstance();
$component->updateConfigurationFromFile(\Alvine\IO\File\File('config.properties'));

Parameters

File $configFile

Return Value

Component Konfiguration

in Component at line 369
Properties getConfiguration()

Konfiguration

Return Value

Properties Konfiguration

in Component at line 386
string getLicense(string $name = null)

Lizenzen

Dieser Befehl listet alle Lizenzen der Komponente auf. Die Lizenzen liegen als Textdatei im Verzeichnis /license der Komponente. Wird ein spezieller Name übergeben, so wird nur diese Lizenz ausgelesen. Der Lizenzname darf keinen Punkt enthalten. An den Lizenznamen wird .txt angehängt.

Parameters

string $name Name der Lizenz

Return Value

string Lizenztext

in Component at line 436
protected Component initEnvironmentRules()

Regeln für die Systemprüfung

Abgeleitete Klassen können diese Methode überschreiben und Ihre eigenen Prüfungen implementieren, sollten aber immer parent::initEnvironmentRules() aufrufen, damit die zentralen Prüfungen laufen.

Das Überschreiben erfolgt, indem mittels Ruleset::add() Methode neue Regeln hinzugefügt werden.

$this->ruleset->add(new PhpModuleRule('gdlib'));

Ist eine Abhängigkeit nicht gegeben, so wird eine entsprechende Exception geworfen.

Notwendige Komponenten

  • PHP-Version muss mindestens \Alvine\Core\Component::REQUIRED_PHP_VERSION sein

Return Value

Component Dieses Objekt

in Component at line 481
static Collection checkCompatibility()

Kompatibilität prüfen

Return Value

Collection geprüfte Komponenten

in Component at line 516
array getDependencyExceptions()

Führt eine Prüfung aus und gibt alle nicht erfüllten Exceptions zurück

Return Value

array

Exceptions

Exception