abstract class Handler extends Alvine implements Filter, InstantiableFromProperties

Abstrakte Klasse eines Handlers, der Log-Nachrichten verarbeitet.

Die Logdaten werden von einem Logger-Objekt an die angebundenen Handler übergeben.

Traits

SerializableImplementation

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.

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected array $buffer
protected Formatter $formatter
protected string $encoding
protected Filter $filter
protected int $threshold Ab diesem Level werden Lognachrichten
protected boolean $loggable Verarbeitet der Handler Logdaten

Methods

string
serialize()

Serialisieren

boolean
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

boolean
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

unserialize(string $serialization)

Klasse deserialisieren

string
__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

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

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

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

from Alvine
boolean
propertyExists(string $name)

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

from Alvine
mixed
__call(string $name, array $arguments)

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

from Alvine
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).

from Alvine
string
getHashCode() deprecated

Die Methode Alvine::getID() verwenden!

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

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

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

from Alvine
Alvine
getClone(boolean $deepClone = false)

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

from Alvine
__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.

from Alvine
string
getClass()

Name der Klasse

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

from Alvine
__construct()

Neuen Handler erstellen

__destruct()

Klasse schliessen

close()

Handler schliessen und flush aufrufen.

flush()

Buffer leeren

string
getEncoding()

No description

setEncoding(type $encoding)

Setzt das Encoding

getFilter()

Filter

publish(LogRecord $record)

Einen Log-Datensatz in den Buffer schreiben.

Formatter
getFormatter()

Gibt den Formatter des Handlers zurück

int
getThreshold()

Gibt den aktuellen Schwellwert zurück

boolean
isLoggable(LogRecord $record)

Prüfen ob der Handler Lofdaten verarbeitet

setFilter(Filter $filter)

Filter setzen

setFormatter(Formatter $formatter)

Setzt das Objekt, das für die Formatierung zuständig ist.

setThreshold(int $level)

Setzt den Schwellwert, ab dem Lognachrichten verarbeitet werden sollen. Die Standardreihenfolge die vom implementierten Filter verwendet wird ist: ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF

setFromProperties(Properties $properties)

Diese interne Methode setzt Standardeigenschaften, die ein Handler haben kann. Dazu gehören folgende Schlüssel-Werte-Paare:

Details

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.

Return Value

string String-Repräsentation des Objektes

boolean hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

boolean

boolean hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

boolean

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.

Parameters

array $serialization Daten des serialisiertes Objekts

Exceptions

UnserializeException Keine Übereinstimmung

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.

Parameters

string $serialization Serialisierte Daten

Exceptions

UnserializeException Exception

in Alvine at line 177
string __toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

Return Value

string Daten des Objekts

in Alvine at line 211
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;

Parameters

string $name Name der Eigenschaft
mixed $value Wert der Eigenschaft

Return Value

void

in Alvine at line 236
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; }

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

Exceptions

BadPropertyException

in Alvine at line 261
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.

Parameters

string $name Name des Closure

Return Value

Closure

Exceptions

NotFoundException
BadPropertyException

in Alvine at line 287
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; }

Parameters

string $name Name der Eigenschaft

Return Value

boolean

in Alvine at line 319
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!

Parameters

string $name Funktionsname
array $arguments Argumente

Return Value

mixed Ergebnis des Callbacks

Exceptions

NotCallableException Exception

in Alvine at line 342
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(); }

Parameters

type $name Name der Methode

Return Value

boolean Ergebnis

in Alvine at line 356
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 376
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)

Return Value

string UUID des Objektes

in Alvine at line 395
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.

Parameters

integer $length Länge der ID

Return Value

string Hashwert des Objektes

in Alvine at line 421
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)) { // ... }

Parameters

Alvine $object Objekt das überprüft werden soll

Return Value

boolean true wenn beide Objekte identisch sind.

in Alvine at line 442
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

Parameters

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

See also

Alvine::__clone

in Alvine at line 454
__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 472
string getClass()

Name der Klasse

class MyObject extends Alvine {}; $obj = new MyObject();

echo $obj->getClass();

Return Value

string Klassenname

See also

ClassType::getNormalizedName

in Alvine at line 497
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

Parameters

object $object

Return Value

boolean

at line 77
__construct()

Neuen Handler erstellen

at line 87
__destruct()

Klasse schliessen

at line 101
Handler close()

Handler schliessen und flush aufrufen.

Diese Methode setzt auch das logable-Flag auf false.

Return Value

Handler Dieses Objekt

at line 111
Handler flush()

Buffer leeren

Return Value

Handler Dieses Objekt

at line 120
string getEncoding()

Return Value

string Encoding

at line 131
Handler setEncoding(type $encoding)

Setzt das Encoding

Parameters

type $encoding Encoding

Return Value

Handler Dieses Objekt

at line 141
Filter getFilter()

Filter

Return Value

Filter Verwendeter Filter

at line 152
Handler publish(LogRecord $record)

Einen Log-Datensatz in den Buffer schreiben.

Parameters

LogRecord $record Log-Datensatz

Return Value

Handler Dieses Objekt

at line 163
Formatter getFormatter()

Gibt den Formatter des Handlers zurück

Return Value

Formatter Formatter

at line 172
int getThreshold()

Gibt den aktuellen Schwellwert zurück

Return Value

int Aktuelle Schwellwert

at line 183
boolean isLoggable(LogRecord $record)

Prüfen ob der Handler Lofdaten verarbeitet

Parameters

LogRecord $record Log-Datensatz

Return Value

boolean Ergebnis der Prüfung

at line 204
Handler setFilter(Filter $filter)

Filter setzen

Parameters

Filter $filter

Return Value

Handler Dieses Objekt

at line 216
Handler setFormatter(Formatter $formatter)

Setzt das Objekt, das für die Formatierung zuständig ist.

Parameters

Formatter $formatter Formatter

Return Value

Handler Dieses Objekt

at line 231
Handler setThreshold(int $level)

Setzt den Schwellwert, ab dem Lognachrichten verarbeitet werden sollen. Die Standardreihenfolge die vom implementierten Filter verwendet wird ist: ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF

Parameters

int $level Level

Return Value

Handler Dieses Objekt

at line 250
protected Handler setFromProperties(Properties $properties)

Diese interne Methode setzt Standardeigenschaften, die ein Handler haben kann. Dazu gehören folgende Schlüssel-Werte-Paare:

loglevel Loglevel des Handlers (ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF) formatter.class Klassenname des Ausgabeformatters

Parameters

Properties $properties Eigenschaften

Return Value

Handler Dieses Objekt

Exceptions

ConfigurationException wird geworfen wenn der Wert der Eigenschaft nicht dem Typ entspricht
InvalidConfigurationException wird geworfen wenn die Eigenschaft falsh konfiguriert wurde