Documentation

Chrome extends Handler
in package

Alvine

Util

Logging

Handler

Der ChromeHandler ist eine Implementierung des Log-Handlers der die Log-Meldungen formatiert und per HTTP-Header an den Browser sendet.

Da nur ein Header gesendet werden kann, löscht die Methode flush() den zwischenspeicher, sendet aber keine Daten.

Chrome hat ein Limit von 250kb für alle Header. Dies ist somit auch die Grenze für die Anzahl der Logdaten, die mit einem Request gesendet werden können.

Zur Darstellung im Browser muss folgende Erweiterung im Chrome installiert werden.

Constants

APIVERSION = 1: Version der API-Version der Klasse.
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
SERIALVERSION = 1: 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.
VERSION = 2: Generelle Alvine-Version

Properties

$buffer : array
$encoding : string
$filter : Filter
$formatter : Formatter
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$header : string
$levelMap : array: ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF Logwerte der ChromeExtension: log , warn, error, info, group, groupEnd, and groupCollapsed.
$loggable : bool: Verarbeitet der Handler Logdaten
$properties : array
$threshold : int: Ab diesem Level werden Lognachrichten

Methods

__call() : mixed: Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
__clone() : mixed: 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.
__construct() : mixed: Neuen Handler erstellen
__destruct() : mixed: Klasse schliessen
__get() : mixed: 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.
__isset() : boolean: Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
__serialize() : array<string|int, mixed>: Serialization of the object and data. In the serialized object also stores meta-information for matching.
__set() : void: Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
__toString() : string: Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
__unserialize() : void
__unset() : mixed: Zurücksetzen von Werten
close() : Chrome: Schliesst diesen Handler, danach werden keine Log-Meldungen mehr über diesen Handler geschrieben.
equals() : boolean: 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.
flush() : Handler: Buffer leeren
getClass() : string: Name der Klasse
getClone() : Alvine: Diese Methode gibt ein geklontes Objekt von sich selber zurück.
getClosure() : Closure: 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.
getEncoding() : string
getFilter() : Filter: Filter
getFormatter() : Formatter: Gibt den Formatter des Handlers zurück
getHashCode() : string: Die Methode Alvine::getID() verwenden!
getID() : string: Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
getInstanceFromProperties() : Chrome: getInstanceFromProperties
getShortID() : string: 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.
getThreshold() : int: Gibt den aktuellen Schwellwert zurück
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
isCallable() : bool: Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
isInstanceOf() : boolean: 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.
isLoggable() : boolean: Prüfen ob der Handler Lofdaten verarbeitet
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
publish() : Handler: Einen Log-Datensatz in den Buffer schreiben.
setEncoding() : Handler: Setzt das Encoding
setFilter() : Handler: Filter setzen
setFormatter() : Handler: Setzt das Objekt, das für die Formatierung zuständig ist.
setThreshold() : Handler: 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
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
sendHeader() : Chrome: Header-Daten senden
setFromProperties() : Handler: Diese interne Methode setzt Standardeigenschaften, die ein Handler haben kann. Dazu gehören folgende Schlüssel-Werte-Paare:

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

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.


    public
        mixed
    SERIALVERSION
    = 1

https://php.watch/versions/8.1/serializable-deprecated

VERSION

Generelle Alvine-Version


    public
        mixed
    VERSION
    = 2

$buffer


    protected
        array
    $buffer
     = array()

Zwischenspeicher für Lognachrichten

$encoding


    protected
        string
    $encoding
     = null

Encoding

$filter


    protected
        Filter
    $filter
     = null

Verwendeter Filter

$formatter


    protected
        Formatter
    $formatter
     = null

Formatter-Objekt

$hasAssociatedProperties


    protected
        boolean
    $hasAssociatedProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$hash

Eindeutige ID


    protected
        string
    $hash
     = null

Die ID wird erst über die Methode \Alvine\Core\Alvine::getID() bei Bedarf ermittelt, deshalb müssen auch abgeleitete Klassen nicht direkt auf den Wert zugreifen, sondern den Wert über getID() holen.

Hash-Wert des Objekts (UUID)

$hasVolatileProperties


    protected
        boolean
    $hasVolatileProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$header


    protected
        string
    $header
     = "X-ChromePhp-Data"

Header-Schlüssel

$levelMap

ALL > TRACE > DEBUG > INFO > WARN > ERROR > FATAL > OFF Logwerte der ChromeExtension: log , warn, error, info, group, groupEnd, and groupCollapsed.


    protected
        array
    $levelMap
     = [
    \Alvine\Util\Logging\Level::FATAL => 'error',
    //System ist unbrauchbar.
    \Alvine\Util\Logging\Level::ERROR => 'error',
    //Fehler aufgetreten.
    \Alvine\Util\Logging\Level::WARN => 'warn',
    //Warnung aufgetreten.
    \Alvine\Util\Logging\Level::INFO => 'info',
    //Normale, aber wichtige Meldung.
    \Alvine\Util\Logging\Level::DEBUG => 'log',
]

Übersetzung Alvine-Level auf ChromeExtension

$loggable

Verarbeitet der Handler Logdaten


    protected
        bool
    $loggable
     = null

Schalter

$properties


    protected
        array
    $properties
     = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

$threshold

Ab diesem Level werden Lognachrichten


    protected
        int
    $threshold
     = null

Level

__call()

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


    public
                    __call(string $name, array $arguments) : mixed

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

$name : string: Funktionsname
$arguments : array: Argumente

Return values

mixed —

Ergebnis des Callbacks

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


    public
                    __clone() : mixed

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

__construct()

Neuen Handler erstellen


    public
                    __construct() : mixed

__destruct()

Klasse schliessen


    public
                    __destruct() : mixed

__get()

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.


    public
                    __get(string $name) : mixed

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

$name : string: Name der Eigenschaft

Return values

mixed —

Wert der Eigenschaft

__isset()

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


    public
                    __isset(string $name) : boolean

Parameters

$name : string

Return values

boolean

__serialize()

Serialization of the object and data. In the serialized object also stores meta-information for matching.


    public
                    __serialize() : array<string|int, mixed>

If a derived class is not to be serializable, then this * method must be overridden and throw an exception. this method must be overridden and throw an exception.

Properties starting with volatile or associated. are handled separately. Properties with prefix volatile are not serialized. For properties with the prefix associated, only the * ID of the object is serialized. ID of the object is serialized. If no object is stored in the property is stored in the property, a TypeException is thrown.

Return values

array<string|int, mixed>

__set()

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.


    public
                    __set(string $name, mixed $value) : void

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

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

Return values

void

__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette


    public
                    __toString() : string

echo (string) new MyObect();

Return values

string —

Daten des Objekts

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

__unset()

Zurücksetzen von Werten


    public
                    __unset(string $name) : mixed

Parameters

$name : string

close()

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


    public
                    close() : Chrome

Return values

Chrome —

Dieses Objekt

equals()

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.


    public
                    equals(Alvine $object) : boolean

class MyObject extends Alvine };

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}

Parameters

$object : Alvine: Objekt das überprüft werden soll

Return values

boolean —

true wenn beide Objekte identisch sind.

flush()

Buffer leeren


    public
                    flush() : Handler

Return values

Handler —

Dieses Objekt

getClass()

Name der Klasse


    public
                    getClass() : string

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

echo $obj->getClass();

Return values

string —

Klassenname

getClone()

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


    public
                    getClone([boolean $deepClone = false ]) : Alvine

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

$deepClone : boolean = false: Clone aller enthaltenen Objekte

Return values

Alvine

getClosure()

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.


    public
                    getClosure(string $name) : Closure

Parameters

$name : string: Name des Closure

Return values

Closure

getEncoding()


    public
                    getEncoding() : string

Return values

string —

Encoding

getFilter()

Filter


    public
                    getFilter() : Filter

Return values

Filter —

Verwendeter Filter

getFormatter()

Gibt den Formatter des Handlers zurück


    public
                    getFormatter() : Formatter

Return values

Formatter —

Formatter

getHashCode()

Die Methode Alvine::getID() verwenden!


    public
                    getHashCode() : string

Return values

string —

Hashwert des Objektes

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.


    public
                    getID() : string

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 values

string —

UUID des Objektes

getInstanceFromProperties()

getInstanceFromProperties


    public
            static        getInstanceFromProperties(Properties $properties) : Chrome

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

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

Parameters

$properties : Properties: Eigenschaften

Return values

Chrome —

Neues Objekt

getShortID()

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.


    public
                    getShortID([int|null $length = null ]) : string

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

$length : int|null = null

Return values

string

getThreshold()

Gibt den aktuellen Schwellwert zurück


    public
                    getThreshold() : int

Return values

int —

Aktuelle Schwellwert

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

isCallable()

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).


    public
                    isCallable(string $name) : bool

if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}

Parameters

$name : string: Name der Methode

Return values

bool —

Ergebnis

isInstanceOf()

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.


    public
                    isInstanceOf(object $object) : boolean

if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

Die Prüfung entspricht

$this instanceof $object

Parameters

$object : object

Return values

boolean

isLoggable()

Prüfen ob der Handler Lofdaten verarbeitet


    public
                    isLoggable(LogRecord $record) : boolean

Parameters

$record : LogRecord

Return values

boolean —

Ergebnis

propertyExists()

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


    public
                    propertyExists(string $name) : boolean

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

$name : string: Name der Eigenschaft

Return values

boolean

publish()

Einen Log-Datensatz in den Buffer schreiben.


    public
                    publish(LogRecord $record) : Handler

Parameters

$record : LogRecord: Log-Datensatz

Return values

Handler —

Dieses Objekt

setEncoding()

Setzt das Encoding


    public
                    setEncoding(type $encoding) : Handler

Parameters

$encoding : type: Encoding

Return values

Handler —

Dieses Objekt

setFilter()

Filter setzen


    public
                    setFilter(Filter $filter) : Handler

Parameters

$filter : Filter

Return values

Handler —

Dieses Objekt

setFormatter()

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


    public
                    setFormatter(Formatter $formatter) : Handler

Parameters

$formatter : Formatter: Formatter

Return values

Handler —

Dieses Objekt

setThreshold()

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


    public
                    setThreshold(int $level) : Handler

Parameters

$level : int: Level

Return values

Handler —

Dieses Objekt

checkAndAdjustSerialisation()

Dealing with versions


    protected
                    checkAndAdjustSerialisation(array $serialization) : array<string|int, mixed>

This method checks an object and ideally repairs older copies. If an old copy cannot be restored be restored, an exception is thrown.

This method must be overridden by the derived classes. be overridden. In the derived class, * the parent method should be called. the parent method should be called.

Parameters

$serialization : array: Daten des serialisiertes Objekts

Return values

array<string|int, mixed>

sendHeader()

Header-Daten senden


    protected
                    sendHeader() : Chrome

Return values

Chrome —

Dieses Objekt

setFromProperties()

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


    protected
                    setFromProperties(Properties $properties) : Handler

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

Parameters

$properties : Properties: Eigenschaften

Return values

Handler —

Dieses Objekt

Chrome extends Handler in package Alvine Util Logging Handler

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$buffer

$encoding

$filter

$formatter

$hasAssociatedProperties

$hash

$hasVolatileProperties

$header

$levelMap

$loggable

$properties

$threshold

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

__destruct()

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

close()

Return values

equals()

Parameters

Return values

flush()

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getEncoding()

Return values

getFilter()

Return values

getFormatter()

Return values

getHashCode()

Tags

Return values

getID()

Chrome extends Handler
in package

Alvine

Util

Logging

Handler