Assembly
abstract class Assembly extends Alvine
Definition eines Rahmen der eine Anwenung kapselt und alle Informationen sammelt.
Eine Anwendung wird über den Factory-Methode execute() gestartet. Als Parameter wird die gewünschte Anwendung als String übergeben.
try {
\Alvine\Application\Assembly::execute(
NAMESPACE.'\Implementation\Main', // Klassenname der Hauptklasse inkl. Namensraum
DIR.DIRECTORY_SEPARATOR. // Pfad auf die Zusammenstellung
'..'.DIRECTORY_SEPARATOR.
'..'.DIRECTORY_SEPARATOR);
} catch(\Exception $e) {
echo $e->getMessage();
}
Die Tasks die eine Anwendung durchführen soll, werden in der Konfigurationsdatei der Anwendung unter den Schlüsseln application.task.* aufgeführt. Soll eine Anwendung einen Task besitzen, so kann die Konfiguration folgendermassen aussehen.
// Initialisieren der Anwendung
application.task.do=runDo
// Es wird die Methode ->runDo() in der Klasse
// der Anwendung aufgerufen.
Constants
DEFAULTSTORAGEHANDLER |
Klassenname des Default-Handlers |
DEFAULTSTORAGEINDEXHANDLER |
Klassenname des Default-Handlers dex Indexers |
UUID |
Statische default UUID dieser Klasse |
DEFAULT_NAME |
Name der Default-Konfigurationsdatei |
PLACEHOLDER_CONFIGPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_DEFAULTPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_ASSETSPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_BASEPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_LICENCEPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_DATAPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_CUSTOMISATIONPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_REPOSITORYPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_VENDORPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_RESOURCEPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_LOGPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_TEMPPATH |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_APPLICATIONID |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
PLACEHOLDER_LANGUAGE |
Mapping der Methode Alvine\Application\Assembly::getPlaceholderMap |
Properties
protected Facility | $facility | ||
protected Node | $configuration | ||
protected Directory | $defaultPath | Im default-Verzeichnis liegen die Standard-Konfigurationsdateien. | |
protected Directory | $basePath | Der Basispfad der Anwendung | |
protected Directory | $vendorPath | ||
protected Directory | $dataPath | ||
protected Directory | $customisationPath | ||
protected Directory | $assetPath | Unter Assets werden Mediadateien wie Grafiken oder CSS-Dateien abgelegt. | |
protected Directory | $classPath | Der Klassenpfad der Anwendung | |
protected Directory | $configPath | Im config-Verzeichnis liegen die Konfigurationsdateien der Anwendung Dieser Pfad zeigt auf die Konfiguration der Facility. | |
protected Directory | $logPath | ||
protected Directory | $licensePath | Lizenzdateien | |
protected Directory | $repositoyPath | Speicherort für Objekte | |
protected Directory | $resourcePath | Resourcen | |
static protected ObjectMap | $instance | Einzige Objektinstanz (singelton) der Anwendung | |
static protected CacheManager | $cacheManager | ||
protected View | $view | ||
protected Examiner | $cacheExaminer | ||
protected EventQueue> | $eventQueues | ||
protected Locale | $locale | ||
protected Manager | $storageManager | ||
protected SMTPClient | $defaultSmtpClient |
Methods
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
Instanz ermitteln. Wird keine Instanzklasse angegeben, so wird das aktuelle Objekt in der Instanz-Map verwendet.
Meßwerte überprüfen
Instanzprüfung inititalisieren
Gültigkeit prüfen
Anwendungsklasse aktualisieren
AppCache zur Beschleunigung von Anfragen
Konfiguration laden
Standardplatzhalter der Anwendung
CustomisationPath
Daten
Standardplatzhalter der Anwendung
No description
Mailclient initialisieren
SMTP-Client
Logging initialisieren
Konfiguration zurückgeben
Diese Methode liest einen Konfigurationswert aus.
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
Nach einem Objekt suchen
Handler für den entsprechenden Speichertyp
Storage-Manager
Objekt aus dem Storage löschen
Objekt in den definierten Speicher schreiben
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.
Abarbeiten der in der Config definierten Tasks
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 mit Resourcen
Resourcen-Datei-Objekt zurückgeben
Verzeichnis für Logdateien
Details
at line 305
protected
__construct(Facility $facility)
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.
at line 327
__destruct()
Anwendung beenden
at line 339
protected Assembly
initEventQueues()
Eventqueues
at line 354
protected EventQueue
getEventQueue(Event $class)
Eventqueue für Event holen und wenn noch nicht vorhanden anlegen
at line 377
Assembly
subscribeEvent(Subscriber $subscriber, string $eventClass)
Event abonnieren
at line 390
Assembly
unsubscribeEvent(Subscriber $subscriber, string $eventClass)
Abmelden
at line 402
Assembly
triggerEvent(Event $event)
Event Triggern
at line 412
bool
shouldBeCached()
Soll die Anwendung cachen
at line 421
Locale
getLocale()
Lokale der Anwendung
at line 456
static Assembly
execute(Facility $facility)
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.
at line 534
static Assembly|null
getInstance(string $assemblyClass = null)
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.
at line 554
boolean|Assembly
validateInstanceCache()
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.
at line 575
protected Assembly
initCacheExaminer()
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.
at line 598
boolean
isInstanceValide()
Gültigkeit prüfen
Prüfen ob die Daten der Instanz noch gültig sind.
at line 613
static
refresh(string $assemblyClass)
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.
at line 652
static CacheManager
getCacheManager()
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.
at line 675
protected Assembly
loadConfig()
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.
at line 731
Map
getPlaceholderMap()
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']
at line 773
Directory
getCustomisationPath()
CustomisationPath
at line 782
Directory
getDataPath()
Daten
at line 793
string
replaceEnvironmentPlaceholder(string $string)
Standardplatzhalter der Anwendung
at line 817
protected
initDirectories()
at line 902
protected Assembly
initSMTPClient()
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)
at line 952
SMTPClient|null
getDefaultSmtpClient()
SMTP-Client
at line 966
protected Assembly
initLogger()
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
at line 1019
Properties
getConfiguration()
Konfiguration zurückgeben
Liefert eine Kopie der Konfigurations. Änderungen in dem Objekt haben keine Auswirkungen auf die Anwenndung.
at line 1036
string
getConfigurationValue(string $key, string $default = null)
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.
at line 1072
protected $this
initPersistenceManager()
Instanz des Storage-Manager holen und Referenz in der Anwendung speichern
at line 1082
protected Assembly
initStorage()
Initialisiert die Struktur für den Objektspeicher.
at line 1100
Assembly
initStorageIndex()
Initialisiert die Struktur für den StorageIndex.
at line 1126
Assembly
registerStorage(string $className, ObjectStorage $storage)
Ein Storageobjekt registrieren.
at line 1138
Assembly
unregisterStorage(string $className)
Registrierung für eine Klasse aufheben
at line 1159
Alvine
getObject(string $className, string $id)
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.
at line 1179
Subset
findObject(string $className, Query $query)
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.
at line 1193
protected ObjectStorage
getPersistenceHandler(string $className, string $mode)
Handler für den entsprechenden Speichertyp
at line 1202
Manager
getStorageManager()
Storage-Manager
at line 1216
Assembly
deleteObject(Alvine $object)
Objekt aus dem Storage löschen
Diese Methode löscht ein Objekt aus dem in der Konfiguration definierten Speicher.
at line 1231
Assembly
writeObject(Alvine $object)
Objekt in den definierten Speicher schreiben
Das übergebene Objekt wird serialisierten und in den angegebenen Speicher geschrieben.
at line 1246
string
getHashCode()
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.
at line 1256
protected Assembly
init()
Task: Init - Inititalisierung der Anwendungsklasse
at line 1267
protected Assembly
finalize()
Abschlußarbeiten
at line 1279
protected Application
handleTasks()
Abarbeiten der in der Config definierten Tasks
at line 1311
Application
setView(View $view)
Neues View setzen
at line 1322
View
getView()
View
at line 1331
Directory
getRepositoyPath()
Speicherort für Daten
at line 1340
Directory
getVendorPath()
Verzeichnis für Fremdanbieterdateien aus dem Backend
at line 1349
Directory
getLicensePath()
Verzeichnis mit Lizenzen
at line 1358
Directory
getDefaultPath()
Verzeichnis der Konfigurationsdateien
at line 1367
Directory
getConfigPath()
Verzeichnis der Konfigurationsdateien
at line 1376
Directory
getAssetPath()
Assets-Verzeichnis
at line 1385
Directory
getBasePath()
Basisverzeichnis
at line 1394
Directory
getClassPath()
Code-Verzeichnis
at line 1403
Directory
getResourcePath()
Verzeichnis mit Resourcen
at line 1430
File
getResourceFile(string $filename)
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');
at line 1453
Directory
getLogPath()
Verzeichnis für Logdateien