class Mail extends File

MailHandler

Der MailHandler ist eine Implementierung des Log-Handlers der die Log-Meldungen formatiert und in einem buffer zwischenspeichert. Beim Schliessen des Handlers oder durch explizites Aufrufen der flush() Methde werden die Datensätze in eine über den Konstruktor definierte Datei geschrieben.

$handler = new \Alvine\Util\Logging\Handler\Mail('\tmp\alvine.log');

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 from Handler
protected Formatter $formatter from Handler
protected string $encoding from Handler
protected Filter $filter from Handler
protected int $threshold Ab diesem Level werden Lognachrichten from Handler
protected boolean $loggable Verarbeitet der Handler Logdaten from Handler
protected path $path Pfad der Logdatei from File
protected ressource $handle Rückgabewert von fopen from File
protected string $linefeed from File
protected MailAddress $from Pfad der Logdatei
protected MailAddress $to Rückgabewert von fopen
protected string $subject
protected SMTPClient $smtpClient

Methods

string
serialize()

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

bool
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

bool
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

void
unserialize(string $serialized)

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
__construct(SMTPClient $smtpClient, string $to, string $from, string $subject)

Erstellt einen neuen Handler, der die Logmeldungen im Anschluß an einen Programmdurchlauf gesammelt per Mail versendet.

__destruct()

Klasse schliessen

from Handler
close()

Schliesst diesen Handler, danach werden keine Log-Meldungen mehr über diesen Handler geschrieben.

flush()

Diese Methode schreibt den Inhalt des Buffers in die geöffnete Datei und leert im Anschluß den Buffer. Wenn ein Formatter verwendet wird, so wird die Methode format des Formatters aufgerufen. Ansonsten wird nur die Log-Meldung ausgegeben. Jeder Datensatz wird mit einem Zeilenend-Zeichen {LF} abgeschlossen.

from File
string
getEncoding()

No description

from Handler
setEncoding(type $encoding)

Setzt das Encoding

from Handler
getFilter()

Filter

from Handler
publish(LogRecord $record)

Einen Log-Datensatz in den Buffer schreiben.

from Handler
Formatter
getFormatter()

Gibt den Formatter des Handlers zurück

from Handler
int
getThreshold()

Gibt den aktuellen Schwellwert zurück

from Handler
boolean
isLoggable(LogRecord $record)

Prüfen ob der Handler Lofdaten verarbeitet

from Handler
setFilter(Filter $filter)

Filter setzen

from Handler
setFormatter(Formatter $formatter)

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

from 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

from Handler
setFromProperties(Properties $properties)

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

from Handler
setLineFeed(string $delimiter)

Setzt das Trennzeichen für Zeilenumbrüche

from File
static object
getInstanceFromProperties(Properties $properties)

Erstellt ein neues MailHandle-Objekt und initialisiert Werte über ein Propertiess-Objekt. Die gültigen Eigenschaften sind:

Details

string serialize()

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

bool hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

bool

bool hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

bool

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

void unserialize(string $serialized)

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

Parameters

string $serialized

Return Value

void

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

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

Parameters

string $name

Return Value

boolean

in Alvine at line 231
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 256
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 281
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 307
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 339
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 362
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 376
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 396
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 416
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 442
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 463
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 475
__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 493
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 518
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 81
__construct(SMTPClient $smtpClient, string $to, string $from, string $subject)

Erstellt einen neuen Handler, der die Logmeldungen im Anschluß an einen Programmdurchlauf gesammelt per Mail versendet.

Parameters

SMTPClient $smtpClient SMTP-Client zum Versenden der Mail.
string $to Kommagetrennte Liste mit Empfängern.
string $from Absender
string $subject Betreff der Mail

See also

Mail

in Handler at line 85
__destruct()

Klasse schliessen

at line 101
Handler close()

Schliesst diesen Handler, danach werden keine Log-Meldungen mehr über diesen Handler geschrieben.

Return Value

Handler Dieses Objekt

in File at line 144
Handler flush()

Diese Methode schreibt den Inhalt des Buffers in die geöffnete Datei und leert im Anschluß den Buffer. Wenn ein Formatter verwendet wird, so wird die Methode format des Formatters aufgerufen. Ansonsten wird nur die Log-Meldung ausgegeben. Jeder Datensatz wird mit einem Zeilenend-Zeichen {LF} abgeschlossen.

Return Value

Handler Dieses Objekt

See also

setLineFeed

in Handler at line 118
string getEncoding()

Return Value

string Encoding

in Handler at line 129
Handler setEncoding(type $encoding)

Setzt das Encoding

Parameters

type $encoding Encoding

Return Value

Handler Dieses Objekt

in Handler at line 139
Filter getFilter()

Filter

Return Value

Filter Verwendeter Filter

in Handler at line 150
Handler publish(LogRecord $record)

Einen Log-Datensatz in den Buffer schreiben.

Parameters

LogRecord $record Log-Datensatz

Return Value

Handler Dieses Objekt

in Handler at line 161
Formatter getFormatter()

Gibt den Formatter des Handlers zurück

Return Value

Formatter Formatter

in Handler at line 170
int getThreshold()

Gibt den aktuellen Schwellwert zurück

Return Value

int Aktuelle Schwellwert

in Handler at line 181
boolean isLoggable(LogRecord $record)

Prüfen ob der Handler Lofdaten verarbeitet

Parameters

LogRecord $record Log-Datensatz

Return Value

boolean Ergebnis der Prüfung

in Handler at line 202
Handler setFilter(Filter $filter)

Filter setzen

Parameters

Filter $filter

Return Value

Handler Dieses Objekt

in Handler at line 214
Handler setFormatter(Formatter $formatter)

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

Parameters

Formatter $formatter Formatter

Return Value

Handler Dieses Objekt

in Handler at line 229
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

in Handler at line 248
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

in File at line 127
File setLineFeed(string $delimiter)

Setzt das Trennzeichen für Zeilenumbrüche

Parameters

string $delimiter Trennzeichen

Return Value

File Dieses Objekt

at line 135
static object getInstanceFromProperties(Properties $properties)

Erstellt ein neues MailHandle-Objekt und initialisiert Werte über ein Propertiess-Objekt. Die gültigen Eigenschaften sind:

from Die E-Mail-Adresse des Absenders to Die E-Mail-Adresse des Empfängers subject Der Betreff der Datei smtpinstancekey Der Name des Schlüssels, unter dem die SMTP-Konfiguration erreichbar ist. Wird kein Name angegeben, so wird nach der Defaultkonfiguration gesucht. loglevel Loglevel des Handlers (ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF) formatter.class Klassenname des Ausgabeformatters

Parameters

Properties $properties Eigenschaften

Return Value

object Ein Objekt