class Ignition

Zentrale Startup-Klasse für Anwendungen

Die Aufgabe der Ignition-Klasse ist das Laden und Einrichten von Biblotheken und Umgebungsvariablen.

Hinweis

* IN DIESER KLASSE SIND DAS FRAMEWORK UND DIE KOMPONENTEN NOCH NICHT VERFÜGBAR!
* ES DÜRFEN DESHALB KEINE FUNKTIONEN DARAUS VERWENDET WERDEN.

Constants

INI_SYSTEM_FILE

Name der system.ini

INI_ASSEMBLY_FILE

PLATFORM-FILE

INI_KEY_FILESYSTEM

Schlüssel für die Dateien

INI_KEY_COMPONENTS

Schlüssel für Komponenten

INI_KEY_COMPONENT

Schlüssel für Komponenten

INI_KEY_ADDITIONAL_COMPONENTS

Schlüssel für zusätzliche Komponenten

INI_KEY_ADDITIONAL_COMPONENT

INI_KEY_ADDITIONAL_COMPONENT

INI_KEY_UNITS

Schlüssel für Komponenten

INI_KEY_EXCEPTION_REPORTER

Schlüssel für Exception-Handling

INI_KEY_EXCEPTION_REPORTER_CLASS

Schlüssel für Exception-Handling

BASEPATH

Hier liegt das Standardsystem (readonly)

VENDORPATH

Phar-Archive, externe Bibliotheken

TEMPPATH

Temporäre Dateien

DATAPATH

Kunden- und Projektspezifische Dateien

LOGPATH

Logging und Debugging

CONFIGPATH

Konfigurationsdateien (Routen, Zugangsdaten)

CUSTOMISATIONPATH

Kunden- und projektspezifischer Code

WEBPATH

über HTTP aufrufbare Dateien

SAPI_KEY_HTTP

HTTP-Schnittstellen-Wert für Konfiguration

SAPI_KEY_CLI

CLI-Schnittstellen-Wert für Konfiguration

SAPI_HTTP

HTTP-Schnittstelle

SAPI_CLI

CLI-Schnittstelle

LINEFEED

Zeilenumbruch

CARRIAGERETURN

Zeilenumbruch

Properties

static protected Ignition $instance
protected array $additionalHints
protected array $iniData
protected boolean|null $returnValue
protected integer $exitValue
protected string $hash
protected string $sapiName
protected integer $sapiType
protected array $headers
protected string $httpStatus
protected array $assemblyIniData
protected array $systemIniData
protected boolean $tputSupport
protected string $bold
protected string $colorBlack
protected string $colorRed
protected string $colorGreen
protected string $colorYellow
protected string $colorBlue
protected string $colorPurple
protected string $colorCyan
protected string $colorWhite
protected string $backgroundColorBlack
protected string $backgroundColorRed
protected string $backgroundColorGreen
protected string $backgroundColorYellow
protected string $backgroundColorBlue
protected string $backgroundColorPurple
protected string $backgroundColorCyan
protected string $backgroundColorWhite
protected string $underline
protected string $dimMode
protected string $resetUnderline
protected string $reset
protected string $name
protected integer $columns
protected integer $lines
protected string $environmentConfigKey

Methods

addHint(string $hint)

No description

initColors()

Farben initialisieren

bool
isCliApi()

Prüfen ob CLI

bool
isHttpApi()

Prüfen ob HTTP

bool|null
getReturnCode()

Return-wert

setReturnCode(bool $code)

No description

string
getID()

Eindeutige ID

int|null
getExitCode()

Exit-Code

setExitCode(int $code)

Exit-Code setzen

static Ignition
getInstance(string $name = null)

Instanz holen oder erstellen

string
getEnvironment(string $key, mixed $default = null)

Environment auslesen und zurückgegen. Es wird in ENV und SERVER gesucht. Wird keine Variable gefunden, wird default zurückgegeben.

array
loadIniFile(string $path)

Ini auslesen

string
getSystemPath(string $name)

Systempfad auslesen

bool
getBooleanFromSystemIni(string $key, string $section, bool $default = false)

Prüft die Verfügbarkeit des Wertes und gibt ein boolean zurück.

string|null
getStringFromSystemIni(string $key, string $section, string|null $default = null)

Prüft die Verfügbarkeit des Wertes und gibt eine Zeichenkette zurück.

static string
sanitizePath(string $path, string|null $basepath = null)

No description

array|null
getSystemIni()

SystemInit

array|null
getAssemblyIni()

Platform

string
getSystemIniPath()

No description

string
getEnvironmentConfigVariable()

Neme der Environmentvariable

string
getAssemblyIniPath()

Assembly-Path

initIniFiles(string $environmentKey)

No description

runUnits()

Ausführen der Units

string
initUnitClassAndGetName(string $unit)

Unit-Klasse einbinden

static string
mask(string $value, string $key = null)

No description

static type
getVariableForJson(type $variable)

No description

static type
getVariableForTextDump(type $label, type $variable)

No description

string|null
tryCreateAndcheckAccessable(string $path)

No description

string|null
string|null
string|null
string|null
getExceptionLogDirectoryHome()

No description

string|null
getHomeDirectory()

No description

string|null
getExceptionLogDirectory()

Logverzeichnis

writeExceptionLog(Exception $exception)

Startup-Log im Fehlerfall schreiben

type
handleExit()

No description

reportException(Exception $exception)

No description

$this
handleException(Exception $exception)

No description

writeToCli(string $text, string|null $modifier = null)

Ausgabe eines Textes

writeLineToCli(string $text, string|null $modifier = null)

Ausgabe einer Zeile

$this
reportCliException(Exception $exception)

No description

$this
reportHttpException(Exception $exception)

No description

string|null
getSupportedMimeType(array $supportedTypes)

No description

sendHeaders()

Headers senden

setHttpStatus(string $status)

HTTP-Status setzen

setHeader(string $key, string $value)

Headers setzen

boolean
shouldExecuteForThisClient(string $pattern)

Prüfen, ob die Anweisung auf dem Client ausgeführt werden soll

Details

at line 404
Ignition addHint(string $hint)

Parameters

string $hint

Return Value

Ignition

at line 414
protected Ignition initColors()

Farben initialisieren

Return Value

Ignition

at line 450
bool isCliApi()

Prüfen ob CLI

Return Value

bool

at line 459
bool isHttpApi()

Prüfen ob HTTP

Return Value

bool

at line 468
bool|null getReturnCode()

Return-wert

Return Value

bool|null

at line 478
Ignition setReturnCode(bool $code)

Parameters

bool $code

Return Value

Ignition

at line 488
string getID()

Eindeutige ID

Return Value

string

at line 497
int|null getExitCode()

Exit-Code

Return Value

int|null

at line 508
Ignition setExitCode(int $code)

Exit-Code setzen

Parameters

int $code

Return Value

Ignition

at line 524
static Ignition getInstance(string $name = null)

Instanz holen oder erstellen

Ignition-Instanz holen, oder falls noch nicht initialisert, neue Instanz erstellen. Der Parameter ´$name´ wird nur beim ersten Aufruf beachtet.

Parameters

string $name Initialisierung mit Anwendungsnamen (nur für den ersten Aufruf wichtig.

Return Value

Ignition

at line 542
string getEnvironment(string $key, mixed $default = null)

Environment auslesen und zurückgegen. Es wird in ENV und SERVER gesucht. Wird keine Variable gefunden, wird default zurückgegeben.

Parameters

string $key
mixed $default

Return Value

string

at line 573
protected array loadIniFile(string $path)

Ini auslesen

Parameters

string $path

Return Value

array

Exceptions

Exception

at line 597
string getSystemPath(string $name)

Systempfad auslesen

Parameters

string $name

Return Value

string

Exceptions

Exception

at line 632
bool getBooleanFromSystemIni(string $key, string $section, bool $default = false)

Prüft die Verfügbarkeit des Wertes und gibt ein boolean zurück.

"true", "1" und "on" werden als true, alle anderen Werte als false zurückgegeben.

Parameters

string $key
string $section
bool $default

Return Value

bool

Exceptions

Exception

at line 670
string|null getStringFromSystemIni(string $key, string $section, string|null $default = null)

Prüft die Verfügbarkeit des Wertes und gibt eine Zeichenkette zurück.

Parameters

string $key
string $section
string|null $default

Return Value

string|null

Exceptions

Exception

at line 698
static string sanitizePath(string $path, string|null $basepath = null)

Parameters

string $path
string|null $basepath Basispfad bei relativen Pfaden

Return Value

string

Exceptions

Exception

at line 749
array|null getSystemIni()

SystemInit

Return Value

array|null

at line 758
array|null getAssemblyIni()

Platform

Return Value

array|null

at line 766
protected string getSystemIniPath()

Return Value

string

at line 788
protected string getEnvironmentConfigVariable()

Neme der Environmentvariable

Return Value

string

at line 797
protected string getAssemblyIniPath()

Assembly-Path

Return Value

string

at line 808
Ignition initIniFiles(string $environmentKey)

Parameters

string $environmentKey

Return Value

Ignition

at line 822
Ignition runUnits()

Ausführen der Units

Return Value

Ignition

Exceptions

Exception

at line 861
protected string initUnitClassAndGetName(string $unit)

Unit-Klasse einbinden

Parameters

string $unit

Return Value

string

Exceptions

Exception

at line 891
static protected string mask(string $value, string $key = null)

Parameters

string $value
string $key

Return Value

string

at line 913
static protected type getVariableForJson(type $variable)

Parameters

type $variable

Return Value

type

at line 946
static protected type getVariableForTextDump(type $label, type $variable)

Parameters

type $label
type $variable

Return Value

type

at line 977
protected string|null tryCreateAndcheckAccessable(string $path)

Parameters

string $path

Return Value

string|null

at line 993
protected string|null getExceptionLogDirectoryFromEnvironment()

Return Value

string|null

at line 1011
protected string|null getExceptionLogDirectoryFromSystemini()

Return Value

string|null

at line 1027
protected string|null getExceptionLogDirectoryFromSystemTemp()

Return Value

string|null

at line 1043
protected string|null getExceptionLogDirectoryHome()

Return Value

string|null

at line 1059
protected string|null getHomeDirectory()

Return Value

string|null

at line 1084
protected string|null getExceptionLogDirectory()

Logverzeichnis

Return Value

string|null

at line 1108
Ignition writeExceptionLog(Exception $exception)

Startup-Log im Fehlerfall schreiben

Parameters

Exception $exception

Return Value

Ignition

at line 1171
type handleExit()

Return Value

type

at line 1198
protected Ignition reportException(Exception $exception)

Parameters

Exception $exception

Return Value

Ignition

Exceptions

Exception

at line 1243
$this handleException(Exception $exception)

Parameters

Exception $exception

Return Value

$this

at line 1274
Ignition writeToCli(string $text, string|null $modifier = null)

Ausgabe eines Textes

Parameters

string $text
string|null $modifier

Return Value

Ignition

at line 1289
Ignition writeLineToCli(string $text, string|null $modifier = null)

Ausgabe einer Zeile

Parameters

string $text
string|null $modifier

Return Value

Ignition

at line 1317
protected $this reportCliException(Exception $exception)

Parameters

Exception $exception

Return Value

$this

at line 1346
protected $this reportHttpException(Exception $exception)

Parameters

Exception $exception

Return Value

$this

at line 1469
protected string|null getSupportedMimeType(array $supportedTypes)

Parameters

array $supportedTypes

Return Value

string|null

at line 1501
protected Ignition sendHeaders()

Headers senden

Return Value

Ignition

Exceptions

Exception

at line 1533
Ignition setHttpStatus(string $status)

HTTP-Status setzen

Parameters

string $status

Return Value

Ignition

Exceptions

Exception

at line 1553
Ignition setHeader(string $key, string $value)

Headers setzen

Parameters

string $key
string $value

Return Value

Ignition

Exceptions

Exception

at line 1570
protected boolean shouldExecuteForThisClient(string $pattern)

Prüfen, ob die Anweisung auf dem Client ausgeführt werden soll

Parameters

string $pattern

Return Value

boolean