class Logger extends AbstractFactory

Logger für das Logging von Meldungen

Der Logger stellt die Hauptfunktionalität im Logging-Prozess zur Verfügung. Er ist für die Filterung und Weitergaben der Lognachrichten verantwortlich.

Die Reihenfolge der Filterung ist dabei so, das ein gesetzter Filter immer den eigenen Level und alle darunter liegende Levels ausgibt. Ein Filter auf WARN gibt auch Meldungen der Stufe ERROR und FATAL aus. ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF

Beispielcode für das Erstellen eines Loggers

// Neue Handler für die Ausgabe in eine Datei erstellen.
$handler = new \Alvine\Util\Logging\Handler\File('/tmp/alvine.log');
// Neuer Logger
$logger = \Alvine\Util\Logging\Logger::getLogger();

// Als Ausgabe soll eine einfache tab-getrennte Liste
// erstellt werden
$formatter = new \Alvine\Util\Logging\Formatter\Plain();

// Zuweisung des handlers und des Formatters
$logger->addHandler($handler);
$handler->setFormatter($formatter);

// Über den Schwellwert kann gesteuert werden,
// welche Meldungen ausgegeben werden sollen.
// In diesem Fall sollen nur Infomeldungen, Warnings,
// Errors und Fatals protokolliert werden.
$handler->setThreshold(\Alvine\Util\Logging\Level::INFO);

// Meldungen mit unterschiedlichen Level
// ausgeben.
$logger->logTrace('Log-Trace');
$logger->logDebug('Log-Debug');
$logger->logInfo('Log-Info');
$logger->logWarn('Log-Warn');
$logger->logError('Log-Error');
$logger->logFatal('Log-Fatal');

Die Ausgabe der Datei alvine.log sieht dann
folgendermassen aus:

2012-01-04 15:19:46 16  Log-Info
2012-01-04 15:19:46 8   Log-Warn
2012-01-04 15:19:46 4   Log-Error
2012-01-04 15:19:46 2   Log-Fatal

Traits

Factory-Implementierung
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
static protected string $defaultname from FactoryImplementation
static protected array $instances from FactoryImplementation
protected string $registeredInstanceName from FactoryImplementation
protected array $handler

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)

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

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
boolean
__isset(string $name)

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

from Alvine
__unset(string $name)

Zurücksetzen von Werten

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(int|null $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
string
getRegisteredInstanceName()

Name der registrierten Instanz

static object
getInstance(string $name = null)

Instanz erstellen

__construct(string $name)

Neuer Logger

__destruct()

Handler automatisch leeren.

static Logger
getLogger(string $name = null)

Erstellt einen neuen Logger.

createRecordAndLog(int $level, string $message)

Erstellt einen neuen LogRecord und übergibt diesen an die Log-Methode des Objekts.

log(type $record)

Übergebenen LogRecord loggen

logTrace(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level TRACE und übergibt diesen an die Log-Methode.

logFatal(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level FATAL und übergibt diesen an die Log-Methode.

logError(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level ERROR und übergibt diesen an die Log-Methode.

logWarn(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level WARN und übergibt diesen an die Log-Methode.

logInfo(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level INFO und übergibt diesen an die Log-Methode.

logDebug(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level DEBUG und übergibt diesen an die Log-Methode.

addHandler(Handler $handler)

Fügt einen Handler hinzu.

array
getHandler()

Gibt eine Liste der Handler zurück

removeHandler(Handler $handler)

Entfernt einen Handler.

notifyHandler(LogRecord $record)

Informiert alle Handler über einen neuen Log-Datensatz

flushHandler()

Alle Handler anweisen, Ihren Inhalt zu schreiben.

static null
flush()

Flush für alle Logger ausführen

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)

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 176
string __toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

Return Value

string Daten des Objekts

in Alvine at line 210
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 221
boolean __isset(string $name)

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

Parameters

string $name

Return Value

boolean

in Alvine at line 230
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 255
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 280
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 306
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 338
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 361
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 375
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 395
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 415
string getShortID(int|null $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 hilfreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision mit anderen Hash vergleichbarer Objekte.

Parameters

int|null $length

Return Value

string

in Alvine at line 441
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 462
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 474
__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 492
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 517
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

in FactoryImplementation at line 67
string getRegisteredInstanceName()

Name der registrierten Instanz

Return Value

string Name

in FactoryImplementation at line 85
static object getInstance(string $name = null)

Instanz erstellen

Erstellt ein neues Objekt und registriert die Instanz unter dem Namen $name oder, wenn kein Name angegeben wurde mit dem Namen default. Ist bereits ein Objekt mit dem übergebenen Namen registriert, so wird dieser zurückgegeben.

Parameters

string $name Unter diesem Namen wird das Objekt registriert

Return Value

object Neues oder registriertes Objekt

Exceptions

FrameworkException Wenn die Klasse nicht ermittelt werden kann.

at line 98
protected __construct(string $name)

Neuer Logger

Erstellt einen neuen Logger. Wird kein Name übergeben, so wird der Root-Logger erstellt. Der Root-Logger hat den Namen root und ist die zentrale Komponente für das Loggin in Alvine2

Parameters

string $name Name des Loggers

at line 106
__destruct()

Handler automatisch leeren.

at line 122
static Logger getLogger(string $name = null)

Erstellt einen neuen Logger.

Diee Methode ist ein Alias für parent::getInstance()

Parameters

string $name Name des Loggers

Return Value

Logger Neuer Logger

at line 135
protected Logger createRecordAndLog(int $level, string $message)

Erstellt einen neuen LogRecord und übergibt diesen an die Log-Methode des Objekts.

Parameters

int $level Level
string $message Log-Nachricht

Return Value

Logger Dieses Objekt

at line 150
Logger log(type $record)

Übergebenen LogRecord loggen

Parameters

type $record Log-Datensatz

Return Value

Logger

at line 164
Logger logTrace(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level TRACE und übergibt diesen an die Log-Methode.

Parameters

string $message Log-Nachricht

Return Value

Logger

at line 177
Logger logFatal(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level FATAL und übergibt diesen an die Log-Methode.

Parameters

string $message Log-Nachricht

Return Value

Logger

at line 190
Logger logError(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level ERROR und übergibt diesen an die Log-Methode.

Parameters

string $message Log-Nachricht

Return Value

Logger

at line 203
Logger logWarn(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level WARN und übergibt diesen an die Log-Methode.

Parameters

string $message Log-Nachricht

Return Value

Logger

at line 216
Logger logInfo(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level INFO und übergibt diesen an die Log-Methode.

Parameters

string $message Log-Nachricht

Return Value

Logger

at line 229
Logger logDebug(string $message)

Erstellt einen neuen LogRecord-Datensatz mit dem Level DEBUG und übergibt diesen an die Log-Methode.

Parameters

string $message Log-Nachricht

Return Value

Logger

at line 242
Logger addHandler(Handler $handler)

Fügt einen Handler hinzu.

Parameters

Handler $handler Handler

Return Value

Logger Dieses Objekt

Exceptions

UnsupportedException HTTP-Logger dürfen nicht den Kanal HTTP oder NETWORKING abbonieren

at line 260
array getHandler()

Gibt eine Liste der Handler zurück

Return Value

array Liste mit allen registrierten Handlern

at line 271
Logger removeHandler(Handler $handler)

Entfernt einen Handler.

Parameters

Handler $handler Handler

Return Value

Logger

at line 284
protected Logger notifyHandler(LogRecord $record)

Informiert alle Handler über einen neuen Log-Datensatz

Parameters

LogRecord $record Datensatz

Return Value

Logger

at line 296
Logger flushHandler()

Alle Handler anweisen, Ihren Inhalt zu schreiben.

Return Value

Logger

at line 312
static null flush()

Flush für alle Logger ausführen

Return Value

null