Console

Neues Anwendugs-Objekt erstellen.

Der Konstruktor erstellt ein neues Objekt und initialisiert die Systeminstanzen für Environment, Encoding, System und Math. Außerdem wird der Anwendung ein SystemLogger und ein Mailserver zugewiesen.

Anwendung beenden

Eventqueues

Eventqueue für Event holen und wenn noch nicht vorhanden anlegen

Event abonnieren

Abmelden

Event Triggern

Soll die Anwendung cachen

Lokale der Anwendung

Programm ausführen

Die execute-Methode sucht nach der gewünschten Anwendung, erstellt ein Objekt der Anwendung, initiert dadurch die Konfiguration und ruft im Anschluß den Taskhandler auf.

Über die optinalen Parameter $namespace und $path können im ersten Aufruf die Anwendungsklassen inititalisiert werden. Bei weiteren Aufrufen, muss dies nicht mehr erfolgen. Der Namespace kann aber auch normal im AutoLoader registriert werden.

Der Task-Handler sorgt dafür, das die in der Konfiguration aufgeführten Task der Reihe nach ausgeführt werden. Durch die Flexibilität der Tasks, können in der konkreten Anwendung unterschiedliche Szenarien implementiert werden.

application.task=init
application.task=render

Über den Anwendungsmodus können bestimmte Regeln definiert werden. So wird der Anwendungscache nur im Produktivsystem aktiviert.

Instanz ermitteln. Wird keine Instanzklasse angegeben, so wird das aktuelle Objekt in der Instanz-Map verwendet.

Wird kein Assembly gefunden, so wird null zurückgegeben.

Meßwerte überprüfen

Mit dieser Methode kann die Anwendung prüfen, ob die zwischengespeicherte Anwendung noch aktuell ist. Abgeleitetet Anwendungen müssen die Methode Application::initCacheExaminer() um die Werte erweitern, die für einen aktuelle Anwendung wichtig sind.

Instanzprüfung inititalisieren

Abgeleitetet Anwendungen müssen diese Methode um die wichtigen Meßwerte erweitern. In dieser Implementierung wird die Konfigurationsdatei als Meßwert verwendet. Ändert sich die Konfigurationdatei, so wird der Cache für ungültig erklärt.

Gültigkeit prüfen

Prüfen ob die Daten der Instanz noch gültig sind.

Anwendungsklasse aktualisieren

Mit dieser Methode wird der Zwischenspeicher der Anwendungsklasse geleert. Beim nächsten Aufruf von Assembly::execute wird das Objekt für diese Klasse neu erstellt.

AppCache zur Beschleunigung von Anfragen

Diese Methode gibt den Anwendungscache zurück. Im Standard ist das temporäre Verzeichnis definiert. Dies sollte in der abgeleiteten Klasse durch eine schnellere Variante (z.B. Memcache) ersetzt werden.

Für Testzwecke und während der Entwicklung einer Anwendung kann diese Methode null zurückgeben. In diesem Fall wird kein Anwendungscache verwendet.

Konfiguration laden

Diese Methode lädt die Konfiguration der Anwendung. Je nach Dateierweiterung wird eine von \Alvine\Types\Properties abgeleitete Klasse geladen. Für die Erweiterung .properties wird ein Objekt der Klasse \Alvine\Application\Configuration\Properties erstellt, für eine Endung .txt würde die Klasse \Alvine\Application\Configuration\Text initiert werden.

Standardplatzhalter der Anwendung

Pfade {CONFIGPATH} Pfad zu den Konfigurationsdateien {DEFAULTPATH} Pfad zu den Standardwerten der Konfiguration {DATAPATH} Pfad zu den Dateien des Projekts {CUSTOMISATIONPATH} Pfad zu Anpassungen {ASSETSPATH} Pfad zu den Assets {BASEPATH} Pfad zu Hauptverzeichnis der Anwendung (muss nicht das Webroot sein) {LICENCEPATH} Pfad zu den Lizenzen {REPOSITORYPATH} Pfad zum Repository {VENDORPATH} Pfad zu Systembibliotheken {RESOURCEPATH} Pfad zu den Resourcen {TEMPPATH} Temporäres Verzeichnis des Systems {LOGPATH} Pfad zum Logverzeichnis

Anwendung {LANGUAGE} Sprache {APPLICATIONID} UUID der Anwendung

Environment {ENV:KEY} Environmentvariable $_ENV['KEY']

Standardplatzhalter der Anwendung

Neue Instanz

Pfade der Anwendung

Mailclient initialisieren

Initialisierung des Standard-Mail-Clients. Die Konfiguration erfolgt über die Eigenschaften application.mail.delivery.** (siehe auch assembly.config)

application.mail.delivery.default.class Klasse, die den Versand übernimmt (von SMTPClient abgeleitet) application.mail.delivery.default.server IP, oder Hostname des Mailservers (Standard ist localhost) application.mail.delivery.default.port IP-Port des SMTP-Servers (Standard ist 25)

SMTP-Client

Logging initialisieren

Inititalisierung des Standardloggers für das Logging. Die Konfiguration erfolgt über die Eigenschaften application.logging.**. Der Logger muß von der Klasse \Alvine\Util\Logging\Logger abgeleitet sein. Für die Verarbeitung können die Handler über die Konfigurationsschlüssel

Konfiguration zurückgeben

Liefert eine Kopie der Konfigurations. Änderungen in dem Objekt haben keine Auswirkungen auf die Anwenndung.

Diese Methode liest einen Konfigurationswert aus.

Ist der Schlüssel nicht angegeben, so wird der Default-Wert zurückgegeben.

Wird ein Teilschlüssel angegeben, so wird ebenfalls der Defaultwert zurückgegeben.

Instanz des Storage-Manager holen und Referenz in der Anwendung speichern

Initialisiert die Struktur für den Objektspeicher.

Initialisiert die Struktur für den StorageIndex.

Ein Storageobjekt registrieren.

Registrierung für eine Klasse aufheben

Objekt aus dem Storage auslesen

Diese Methode liest ein Objekt aus dem in der Konfiguration definierten Speicher aus. Der Klassenname muss mit führendem \ und vollem Namensraum angegeben werden.

Nach einem Objekt suchen

Die Suche erfolgt in dem in der Konfiguration definierten Indexer. Der Indexer gibt eine Ergebnismenge zurück. Diese Methode holt sich die ID des Ergebnisses und verwendet die Methode getObject um das echte Objekt zu laden.

Handler für den entsprechenden Speichertyp

Storage-Manager

Objekt aus dem Storage löschen

Diese Methode löscht ein Objekt aus dem in der Konfiguration definierten Speicher.

Objekt in den definierten Speicher schreiben

Das übergebene Objekt wird serialisierten und in den angegebenen Speicher geschrieben.

Diese Methode berechnet einen eindeutigen Wert für eine Anwendung. Da jede Anwendung nur eine Instanz haben kann, muss dieser Wert nur zu Klasse hin eindeutig sein.

Der Anwendungscache verwendet die ID um die Instanz der Anwendung zwischenzuspeichern. Diese Methode sollte deshalb von abgeleiteten Klassen nicht überschrieben werden.

Initialisieren der Anwendung

Abschlußarbeiten

Abarbeiten der in der Config definierten Tasks

Neues View setzen

View

CustomisationPath

Daten

Speicherort für Daten

Verzeichnis für Fremdanbieterdateien aus dem Backend

Verzeichnis mit Lizenzen

Verzeichnis der Konfigurationsdateien

Verzeichnis der Konfigurationsdateien

Assets-Verzeichnis

Basisverzeichnis

Code-Verzeichnis

Verzeichnis für Logdateien

Verzeichnis mit Resourcen

Resourcen-Datei-Objekt zurückgeben

Die Methode sucht entweder im Resourcen-Verzeichnis der Anwendung oder im Absoluten-Pfad nach der Resourcen-Datei. Ist der Dateiname eine http-Resource so wird die Datei geladen und in eine temporäre Datei gespeichert. Dieses Dateiobjekt wird zurückgegeben.

// Temporäre Datei mit dme Inhalt von www.example.com
$this->getResourceFile('http://www.example.com/');
// Absolute Datei auf einem Windows-System
$this->getResourceFile('file://c:\temp\myfile.txt');
// Absolute Datei auf einem Unix-System (ohne file://)
$this->getResourceFile('/tmp/myfile.txt');
// Absolute Datei auf einem Unix-System (mit file://)
$this->getResourceFile('file:///tmp/myfile.txt');

Hint hinzufügen

Hints leeren

Exitcode

Exitcode

Das aktuelle Terminal-Objekt holen

Text Zeilenweise Ausgeben

i18n Schlüssel ersetzen und Text ausgeben

Text ausgeben

Internationalisierung

Die Platzhalter müssen mit i18n anfangen:

i18n{mykeytoreplace}

Die Eigenschaft muss dann mit dem Schlüssel angelegt werden:

mykeytoreplace=Text

In der Anwendungskonfiguration kann der Schlüssel application.web.i18n.showkeys auf true gesetzt werden.

Wird die Zeichenkette $quoteCharList übergeben, so werden alle Zeichen die darin enthalten sind mit einem Backslash versehen. Diese Funktion verwendet die PHP Version \addcslashes

Lokalisierten Text holen

Beispiele wenn der Schlüssel nicht gefunden wird:

// Lokalisierung mit Default-Wert
Presenter::getText('my.key::name=Hans', 'Hallo!');
-> Hallo!

// Wird kein Default übergeben wird der Schlüssel ausgegeben
Presenter::getText('my.key::name=Hans');
-> my.key::name=Hans

Ressourcentexte initialisieren

Anwendung ausführen

Werden keine oder die falschen Argumente übergeben, so gibt die Methode den Hilfstext, der durch die Befehle definiert wurde zurück.