Component

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.

Prüfen ob das Objekt associative Eigenschaften besitzt

Prüfen ob das Objekt volatile Eigenschaften besitzt

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.

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

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

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;

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

Zurücksetzen von Werten

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;
}

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.

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;
}

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!

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();
}

Die Methode Alvine::getID() verwenden!

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)

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.

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)) {
  // ...
}

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

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.

Name der Klasse

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

echo $obj->getClass();

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

Instanz erstellen

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

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.

Klassenpfad

Diese Methode muss von abgeleiteten Klassen implementiert werden um das lokale Verzeichnis der Komponente zu ermitteln.

Die Standardimplementierung ist:

protected function getBasePath() {
  return (new \Alvine\IO\File\Directory(__DIR__))->parent();
}

Konfigurationsverzeichnis

Konfigurationsverzeichnis mit Defaults

Lizenzen

Assets

Ressourcen

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');

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.

Name der Komponent

Eigenschaften setzen

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

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'));

Konfiguration

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.

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

Kompatibilität prüfen

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