abstract class Console extends Assembly

Implementierung einer Konsolen-Anwendung

Constants

UUID

Default UUID dieser Klasse

DEFAULTSTORAGEHANDLER

Klassenname des Default-Handlers

LOCATIONS_CLASS

Klasse in der die Locations definiert sind Diese Konstante kann von abgeleiteten Klassen überschrieben werden.

DEFAULTSTORAGEINDEXHANDLER

Klassenname des Default-Handlers dex Indexers

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

EXIT_OK

Anwendung normal beendet

EXIT_ERROR

Allgemeiner Fehler

EXIT_EXCEPTION

Fehler beim Parsen

EXIT_PARSEEXCEPTION

Fehler beim Parsen

EXIT_MISSINGOPTION

Fehlende Option

EXIT_UNSUPPORTED

Nicht unterstützt

EXIT_LIMITEXCEPTION

Zuviel Optionen

EXIT_DATASOURCEEXCEPTION

Datenbank-Ausnahme

Properties

protected Facility $facility from Assembly
protected Node $configuration from Assembly
static protected ObjectMap $instance Einzige Objektinstanz (singelton) der Anwendung from Assembly
protected Locations $locations from Assembly
static protected CacheManager $cacheManager from Assembly
protected View $view from Assembly
protected Examiner $cacheExaminer from Assembly
protected EventQueue> $volatileEventQueues from Assembly
protected Locale $locale from Assembly
protected Manager $storageManager from Assembly
protected SMTPClient $defaultSmtpClient from Assembly
protected ArgumentParser $parser
protected Terminal $terminal
protected integer $exitCode
protected PropertyText $resourceText
protected array $hints

Methods

__construct(Facility $facility)

Neues Anwendugs-Objekt erstellen.

__destruct()

Anwendung beenden

from Assembly
initEventQueues()

Eventqueues

from Assembly
EventQueue
getEventQueue(Event $class)

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

from Assembly
subscribeEvent(Subscriber $subscriber, string $eventClass)

Event abonnieren

from Assembly
unsubscribeEvent(Subscriber $subscriber, string $eventClass)

Abmelden

from Assembly
triggerEvent(Event $event)

Event Triggern

from Assembly
bool
shouldBeCached()

Soll die Anwendung cachen

from Assembly
Locale
getLocale()

Lokale der Anwendung

from Assembly
static Assembly
execute(Facility $facility)

Programm ausführen

from Assembly
static Assembly
checkCompatibility(Throwable $e)

Prüpft ob die Kompatibilität eingehalten wurde.

from Assembly
static Assembly|null
getInstance(string $assemblyClass = null)

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

from Assembly
boolean|Assembly
validateInstanceCache()

Meßwerte überprüfen

from Assembly
initCacheExaminer()

Instanzprüfung inititalisieren

from Assembly
boolean
isInstanceValide()

Gültigkeit prüfen

from Assembly
static void
refresh(string $assemblyClass)

Anwendungsklasse aktualisieren

from Assembly
static CacheManager
getCacheManager()

AppCache zur Beschleunigung von Anfragen

from Assembly
loadConfig()

Konfiguration laden

from Assembly
Map
getPlaceholderMap()

Standardplatzhalter der Anwendung

from Assembly
string
replaceEnvironmentPlaceholder(string $string)

Standardplatzhalter der Anwendung

from Assembly
initLocationsInstance()

Neue Instanz

from Assembly
string
getLocationsClass()

No description

from Assembly
getLocations()

Pfade der Anwendung

from Assembly
initDirectories()

No description

from Assembly
Assembly
initSMTPClient()

Mailclient initialisieren

from Assembly
SMTPClient|null
getDefaultSmtpClient()

SMTP-Client

from Assembly
Assembly
initLogger()

Logging initialisieren

from Assembly
getConfiguration()

Konfiguration zurückgeben

from Assembly
string
getConfigurationValue(string $key, string $default = null)

Diese Methode liest einen Konfigurationswert aus.

from Assembly
$this
initPersistenceManager()

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

from Assembly
initStorage()

Initialisiert die Struktur für den Objektspeicher.

initStorageIndex()

Initialisiert die Struktur für den StorageIndex.

from Assembly
registerStorage(string $className, ObjectStorage $storage)

Ein Storageobjekt registrieren.

from Assembly
unregisterStorage(string $className)

Registrierung für eine Klasse aufheben

from Assembly
Alvine
getObject(string $className, string $id)

Objekt aus dem Storage auslesen

from Assembly
Subset
findObject(string $className, Query $query)

Nach einem Objekt suchen

from Assembly
ObjectStorage
getPersistenceHandler(string $className, string $mode)

Handler für den entsprechenden Speichertyp

from Assembly
Manager
getStorageManager()

Storage-Manager

from Assembly
deleteObject(Alvine $object)

Objekt aus dem Storage löschen

from Assembly
writeObject(Alvine $object)

Objekt in den definierten Speicher schreiben

from Assembly
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.

from Assembly
init()

Initialisieren der Anwendung

finalize()

Abschlußarbeiten

from Assembly
Application
handleTasks()

Abarbeiten der in der Config definierten Tasks

Alvin
setView(View $view)

Neues View setzen

from Assembly
getView()

View

from Assembly
Directory
getCustomisationPath() deprecated

CustomisationPath

from Assembly
Directory
getDataPath() deprecated

Daten

from Assembly
Directory
getRepositoyPath() deprecated

Speicherort für Daten

from Assembly
Directory
getVendorPath() deprecated

Verzeichnis für Fremdanbieterdateien aus dem Backend

from Assembly
Directory
getLicensePath() deprecated

Verzeichnis mit Lizenzen

from Assembly
Directory
getDefaultPath() deprecated

Verzeichnis der Konfigurationsdateien

from Assembly
Directory
getConfigPath() deprecated

Verzeichnis der Konfigurationsdateien

from Assembly
Directory
getAssetPath() deprecated

Assets-Verzeichnis

from Assembly
Directory
getBasePath() deprecated

Basisverzeichnis

from Assembly
Directory
getClassPath() deprecated

Code-Verzeichnis

from Assembly
Directory
getLogPath() deprecated

Verzeichnis für Logdateien

from Assembly
Directory
getResourcePath() deprecated

Verzeichnis mit Resourcen

from Assembly
File
getResourceFile(string $filename)

Resourcen-Datei-Objekt zurückgeben

from Assembly
addHint(string $message)

Hint hinzufügen

clearHints()

Hints leeren

setExitCode(integer $code)

Exitcode

integer
getExitCode()

Exitcode

static ArrayHelper
getCallArguments()

No description

getTerminal()

Das aktuelle Terminal-Objekt holen

writeLine(string $text, Color $foreground = null, Color $background = null)

Text Zeilenweise Ausgeben

write(string $text)

i18n Schlüssel ersetzen und Text ausgeben

writeRaw(string $text)

Text ausgeben

writeError(string $message)

No description

writeHint(string $message)

No description

writeHints()

No description

handleException(Throwable $exception, int $exitcode = null)

No description

string
replaceI18N(string $content, string $quoteCharList = null)

Internationalisierung

string
getText(string $text, string $default = null, string $pluralKey = null)

Lokalisierten Text holen

initResourceText(string $resource = null, Directory $basepath = null)

Ressourcentexte initialisieren

getParser()

No description

run()

Anwendung ausführen

addArgumentsByDirectory(Directory $directory)

No description

string|null
getCommandClassFromFile(File $file)

No description

Details

at line 128
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.

Parameters

Facility $facility

Exceptions

ConfigurationException

in Assembly at line 257
__destruct()

Anwendung beenden

in Assembly at line 269
protected Assembly initEventQueues()

Eventqueues

Return Value

Assembly

in Assembly at line 284
protected EventQueue getEventQueue(Event $class)

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

Parameters

Event $class

Return Value

EventQueue

Exceptions

TypeException

in Assembly at line 307
Assembly subscribeEvent(Subscriber $subscriber, string $eventClass)

Event abonnieren

Parameters

Subscriber $subscriber
string $eventClass

Return Value

Assembly

in Assembly at line 320
Assembly unsubscribeEvent(Subscriber $subscriber, string $eventClass)

Abmelden

Parameters

Subscriber $subscriber
string $eventClass

Return Value

Assembly

in Assembly at line 332
Assembly triggerEvent(Event $event)

Event Triggern

Parameters

Event $event

Return Value

Assembly

in Assembly at line 342
bool shouldBeCached()

Soll die Anwendung cachen

Return Value

bool

in Assembly at line 351
Locale getLocale()

Lokale der Anwendung

Return Value

Locale

in Assembly at line 386
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.

Parameters

Facility $facility

Return Value

Assembly Instanz der Anwendung

Exceptions

AssemblyNotFoundException
InvalidArgumentException

in Assembly at line 467
static protected Assembly checkCompatibility(Throwable $e)

Prüpft ob die Kompatibilität eingehalten wurde.

Parameters

Throwable $e

Return Value

Assembly

Exceptions

Throwable

in Assembly at line 507
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.

Parameters

string $assemblyClass

Return Value

Assembly|null

in Assembly at line 527
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.

Return Value

boolean|Assembly

Exceptions

InvalidProbeException

in Assembly at line 548
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.

Return Value

Assembly Dieses Objekt

in Assembly at line 574
boolean isInstanceValide()

Gültigkeit prüfen

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

Return Value

boolean Ergebnis

in Assembly at line 593
static void 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.

Parameters

string $assemblyClass

Return Value

void

Exceptions

AssemblyNotFoundException

in Assembly at line 639
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.

Return Value

CacheManager CacheManager

in Assembly at line 662
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.

Return Value

Assembly

Exceptions

ConfigurationException
NotFoundException

in Assembly at line 718
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']

Return Value

Map Systemplatzhalter

in Assembly at line 762
string replaceEnvironmentPlaceholder(string $string)

Standardplatzhalter der Anwendung

Parameters

string $string Inhalt

Return Value

string Inhalt mit ersetzten Platzhaltern

in Assembly at line 774
protected Assembly initLocationsInstance()

Neue Instanz

Return Value

Assembly

in Assembly at line 784
protected string getLocationsClass()

Return Value

string

in Assembly at line 793
Locations getLocations()

Pfade der Anwendung

Return Value

Locations

in Assembly at line 823
protected initDirectories()

in Assembly at line 841
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)

Return Value

Assembly Dieses Objekt

in Assembly at line 891
SMTPClient|null getDefaultSmtpClient()

SMTP-Client

Return Value

SMTPClient|null

in Assembly at line 905
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

Return Value

Assembly Dieses Objekt

in Assembly at line 958
Properties getConfiguration()

Konfiguration zurückgeben

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

Return Value

Properties

in Assembly at line 975
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.

Parameters

string $key Schlüssel
string $default Wert

Return Value

string Konfigurationswert

in Assembly at line 1018
protected $this initPersistenceManager()

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

Return Value

$this

at line 506
protected Assembly initStorage()

Initialisiert die Struktur für den Objektspeicher.

Return Value

Assembly

in Assembly at line 1060
Assembly initStorageIndex()

Initialisiert die Struktur für den StorageIndex.

Return Value

Assembly

in Assembly at line 1092
Assembly registerStorage(string $className, ObjectStorage $storage)

Ein Storageobjekt registrieren.

Parameters

string $className Für diese Klasse oder das Interface gilt das Storageobjekt
ObjectStorage $storage Storageobjekt

Return Value

Assembly Dieses Objekt

in Assembly at line 1104
Assembly unregisterStorage(string $className)

Registrierung für eine Klasse aufheben

Parameters

string $className Name der Klasse

Return Value

Assembly Dieses Objekt

in Assembly at line 1125
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.

Parameters

string $className Name der Klasse
string $id ID des Objektes

Return Value

Alvine Gespeicherte Klasse

in Assembly at line 1145
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.

Parameters

string $className Klassenname
Query $query Query

Return Value

Subset Ergebnismenge

Exceptions

NullException Es wurde kein Handler für den Typ gefunden
FindException Im Ergebnis wurde ein Eintrag ohne UUID oder Type gefunden. Wahrscheinlich ist der Index nicht mehr konsistent.

in Assembly at line 1159
protected ObjectStorage getPersistenceHandler(string $className, string $mode)

Handler für den entsprechenden Speichertyp

Parameters

string $className Klassenname
string $mode Mode für die Exception

Return Value

ObjectStorage

Exceptions

NullException Nicht gefunden

in Assembly at line 1168
Manager getStorageManager()

Storage-Manager

Return Value

Manager

in Assembly at line 1182
Assembly deleteObject(Alvine $object)

Objekt aus dem Storage löschen

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

Parameters

Alvine $object zu löschende Objekt

Return Value

Assembly Dieses Objekt

in Assembly at line 1197
Assembly writeObject(Alvine $object)

Objekt in den definierten Speicher schreiben

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

Parameters

Alvine $object zu speicherndes Objekt

Return Value

Assembly Dieses Objekt

in Assembly at line 1212
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.

Return Value

string Hashwert des Objektes

at line 185
Assembly init()

Initialisieren der Anwendung

Return Value

Assembly

in Assembly at line 1233
protected Assembly finalize()

Abschlußarbeiten

Return Value

Assembly Dieses Objekt

at line 579
protected Application handleTasks()

Abarbeiten der in der Config definierten Tasks

Return Value

Application Dieses Objekt

Exceptions

TaskNotFoundException Der Task wurde nicht gefunden.

in Assembly at line 1282
Alvin setView(View $view)

Neues View setzen

Parameters

View $view View

Return Value

Alvin e\Application\Application Dieses Objekt

in Assembly at line 1295
View getView()

View

Return Value

View View

in Assembly at line 1306
Directory getCustomisationPath() deprecated

deprecated since version 20200707

CustomisationPath

in Assembly at line 1317
Directory getDataPath() deprecated

deprecated since version 20200707

Daten

in Assembly at line 1328
Directory getRepositoyPath() deprecated

deprecated since version 20200707

Speicherort für Daten

in Assembly at line 1339
Directory getVendorPath() deprecated

deprecated since version 20200707

Verzeichnis für Fremdanbieterdateien aus dem Backend

in Assembly at line 1350
Directory getLicensePath() deprecated

deprecated since version 20200707

Verzeichnis mit Lizenzen

in Assembly at line 1361
Directory getDefaultPath() deprecated

deprecated since version 20200707

Verzeichnis der Konfigurationsdateien

in Assembly at line 1372
Directory getConfigPath() deprecated

deprecated since version 20200707

Verzeichnis der Konfigurationsdateien

in Assembly at line 1383
Directory getAssetPath() deprecated

deprecated since version 20200707

Assets-Verzeichnis

in Assembly at line 1394
Directory getBasePath() deprecated

deprecated since version 20200707

Basisverzeichnis

in Assembly at line 1405
Directory getClassPath() deprecated

deprecated since version 20200707

Code-Verzeichnis

in Assembly at line 1416
Directory getLogPath() deprecated

deprecated since version 20200707

Verzeichnis für Logdateien

in Assembly at line 1427
Directory getResourcePath() deprecated

deprecated since version 20200707

Verzeichnis mit Resourcen

in Assembly at line 1454
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');

Parameters

string $filename Dateiname oder URI

Return Value

File

at line 165
Console addHint(string $message)

Hint hinzufügen

Parameters

string $message

Return Value

Console

at line 175
Console clearHints()

Hints leeren

Return Value

Console

at line 210
Console setExitCode(integer $code)

Exitcode

Parameters

integer $code

Return Value

Console

at line 220
integer getExitCode()

Exitcode

Return Value

integer Exitcode

at line 230
static ArrayHelper getCallArguments()

Return Value

ArrayHelper

Exceptions

ParserException

at line 252
Terminal getTerminal()

Das aktuelle Terminal-Objekt holen

Return Value

Terminal

at line 265
Console writeLine(string $text, Color $foreground = null, Color $background = null)

Text Zeilenweise Ausgeben

Parameters

string $text
Color $foreground
Color $background

Return Value

Console

at line 281
Console write(string $text)

i18n Schlüssel ersetzen und Text ausgeben

Parameters

string $text

Return Value

Console

at line 295
Console writeRaw(string $text)

Text ausgeben

Parameters

string $text

Return Value

Console

at line 308
Console writeError(string $message)

Parameters

string $message

Return Value

Console

at line 338
Console writeHint(string $message)

Parameters

string $message

Return Value

Console

at line 360
Console writeHints()

Return Value

Console

at line 392
Console handleException(Throwable $exception, int $exitcode = null)

Parameters

Throwable $exception
int $exitcode

Return Value

Console

at line 445
string replaceI18N(string $content, string $quoteCharList = null)

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

Parameters

string $content Inhalt
string $quoteCharList Quote

Return Value

string

at line 493
string getText(string $text, string $default = null, string $pluralKey = null)

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

Parameters

string $text Textvorlage in der Form Schlüssel::key1=value1::key2=value2....
string $default Defaultwert
string $pluralKey Name des Schlüssels der Mehrzahlregel

Return Value

string lokalisierter Text

at line 525
DefaultPresenter initResourceText(string $resource = null, Directory $basepath = null)

Ressourcentexte initialisieren

Parameters

string $resource
Directory $basepath

Return Value

DefaultPresenter

at line 568
ArgumentParser getParser()

Return Value

ArgumentParser

at line 594
Console handleExceptionMessage(Throwable $e)

Parameters

Throwable $e

Return Value

Console

at line 647
Console run()

Anwendung ausführen

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

Return Value

Console

at line 689
protected Console addArgumentsByDirectory(Directory $directory)

Parameters

Directory $directory

Return Value

Console

at line 734
protected string|null getCommandClassFromFile(File $file)

Parameters

File $file

Return Value

string|null