Component
abstract class Component extends Alvine
Die Komponentenklasse stellt Methoden zur Verfügung, um Informationen der abgeleiteten Komponenten zu erhalten.
Für den Zugriff auf eine Komponente muss die Instanz über Component::getInstance() geholt werden.
$component = \Alvine\Documentation\mycomponent\Component::getInstance();
Der Zugriff auf die Komponenten-Konfiguration erfolgt direkt über die Eigenschaften.
$component = \Alvine\Documentation\mycomponent\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\mycomponent\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
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_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 | ||
protected null|string | $version | ||
protected string | $name | ||
protected Ruleset | $ruleset |
Methods
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
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.
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.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
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 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.
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
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.
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.
Komponente
Klassenpfad
Konfigurationsverzeichnis
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
Version in der Form major.minor.build ausgeben.
Name
Konfiguration
Komponente aus der Anwendung entfernen. Die Basisfunktion löscht bei einer Webanwendung das Verzeichnis Webverzeichnis/[namederkomponente]/ und die Konfigurationsdatei
Lizenzen
Regeln für die Systemprüfung
Kompatibilität prüfen
Führt eine Prüfung aus und gibt alle nicht erfüllten Exceptions zurück
Details
in SerializableImplementation at line 125
string
serialize()
Serialisieren
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.
in SerializableImplementation at line 197
boolean
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 209
boolean
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 232
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.
in SerializableImplementation at line 257
unserialize(string $serialization)
Klasse deserialisieren
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
in Alvine at line 178
string
__toString()
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
echo (string) new MyObect();
in Alvine at line 212
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;
in Alvine at line 223
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 232
__unset(string $name)
Zurücksetzen von Werten
in Alvine at line 257
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;
}
in Alvine at line 282
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.
in Alvine at line 308
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;
}
in Alvine at line 340
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!
in Alvine at line 363
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();
}
in Alvine at line 377
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
in Alvine at line 397
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)
in Alvine at line 416
string
getShortID(integer $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 hilreich um Platz zu sparen.
Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision.
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)) {
// ...
}
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
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();
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
in SingletonImplementation at line 64
static object
getInstance()
Instanz erstellen
Erstellt ein neues Objekt. Ist bereits ein Objekt registriert, so wird dieser zurückgegeben.
at line 135
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 167
abstract protected Directory
getBasePath()
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();
}
at line 174
Directory
getConfigPath()
Konfigurationsverzeichnis
at line 183
Directory
getLicensePath()
Lizenzen
at line 192
Directory
getAssetPath()
Assets
at line 201
Directory
getResourcePath()
Ressourcen
at line 235
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');
at line 265
string
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.
at line 288
string
getName()
Name
Name der Komponent
at line 307
Component
updateConfiguration(Properties $properties)
Eigenschaften setzen
Über diese Methode können Anwendungseigenschaften gesetzt werden, die die entsprechenden Komponenteneigenschaften überschreiben.
at line 327
Properties
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->loadCustomConfiguration(\Alvine\IO\File\File('config.properties'));
at line 337
Properties
getConfiguration()
Konfiguration
at line 358
Component
install(Assembly $application)
Installieren
Komponente in der Anwendung installieren. Die Basisklasse kopiert bei einer Webanwendung alle Inhalte aus dem Verzeichnis asset/web/ in das Webverzeichnis/[namederkomponente]/ der Anwendung. Die Methode verwendet dafür die Methode \Alvine\Application\Web::getWebPath()
Außerdem wird, sofern nicht bereits vorhanden, eine leere Konfigurationdatei in dem Konfigurationsverzeichnis der Anwendung angelegt.
at line 392
Component
uninstall(Assembly $application)
Komponente aus der Anwendung entfernen. Die Basisfunktion löscht bei einer Webanwendung das Verzeichnis Webverzeichnis/[namederkomponente]/ und die Konfigurationsdatei
Alle Einstellungen gehen verloren!
at line 418
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.
at line 467
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
at line 507
static Component>
checkCompatibility()
Kompatibilität prüfen
at line 538
FrameworkException>]
getDependencyExceptions()
Führt eine Prüfung aus und gibt alle nicht erfüllten Exceptions zurück