Documentation

Session extends Alvine
in package

Alvine

Net

Session

Die Session-Klasse stellt eine Möglichkleit bereit, Daten über mehrere statuslose Requests bereitzuhalten und damit einen Workflow abzubilden.

Um andere Daten in der Session zu speichern, können einfach weitere Eigenschaften hinzugefügt werden. Diese Funktionalität wird von der __get und __set Methode der \Alvine\Core\Alvine Klasse bereitgestellt.

$session = new \Alvine\Net\Session\Session();
$session->meineWerte = 'Me and You';

// Speichern einer Session
$storage = new \Alvine\Persistence\ObjectStorage(new \Alvine\Persistence\Provider\File\DataObject('\tmp\session\'));
$storage->writeObject($session);
// Laden einer Session
$id = 'ada9f10f-bc64-4d9f-f82d-154d4ba82e3c'; // kommt normalerweise über cookie oder request
$storage = new \Alvine\Persistence\ObjectStorage(new \Alvine\Persistence\Provider\File\DataObject('c:\\temp\\storage'));
$session = $storage->getObjectByID($id);

Constants

APIVERSION = 1: Version der API-Version der Klasse.
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
LIVETIME = 3600: Standard-Lebenszeit einer Session 1 Stunde
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.
SESSIONKEY = 'sid': Schlüssel für eine Session
VERSION = 2: Generelle Alvine-Version

Properties

$creationTime : int
$expiration : integer
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$identity : Identity
$lastAccessTime : int
$nonce : array: Ein Nonce (oder Zufallstoken) wird für einen Request erstellt und kann mit einem Formular zurückgesendet werden. Jeder Nonce kann nur einmal verwendet werden.
$properties : array
$transcript : array

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: Session erstellen
__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() : string: Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.
__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: Deserialisierung
__unset() : mixed: Zurücksetzen von Werten
addNonce() : Session: Neuen Nonce erstellen
clearTranscripts() : array: Liste mit dem Verlauf der Session leeren.
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.
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.
getCurrentTranscript() : Transcript: Eine Abschrift stellt Daten der aktuellen Anfrage bereit.
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.
getIdentity() : Identity: Identität
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.
getTranscripts() : array: Liefert eine Liste mit dem Verlauf der Session.
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
invalidate() : Session: Session entwerten
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.
isValid() : boolean: Überprüft die Session
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
redeemedNonce() : boolean: Nonce entwerten
setExpiration() : Session: Ablaufdatum setzen
setIdentity() : Session: Diese Methode ordnet der Session eine Identität zu.
validateID() : boolean: Überprüft ob der übergebene String einer gültigen Session-ID entspricht.
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
validate() : Session: Session prüfen

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

LIVETIME

Standard-Lebenszeit einer Session 1 Stunde


    public
        mixed
    LIVETIME
    = 3600

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

SESSIONKEY

Schlüssel für eine Session


    public
        mixed
    SESSIONKEY
    = 'sid'

VERSION

Generelle Alvine-Version


    public
        mixed
    VERSION
    = 2

$creationTime


    protected
        int
    $creationTime
     = null

Session erstellt

$expiration


    protected
        integer
    $expiration
     = null

Zeitpunkt des Ablaufs der Session

$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)

$identity


    protected
        Identity
    $identity
     = null

Identität

$lastAccessTime


    protected
        int
    $lastAccessTime
     = null

letzter Zugriff

$nonce

Ein Nonce (oder Zufallstoken) wird für einen Request erstellt und kann mit einem Formular zurückgesendet werden. Jeder Nonce kann nur einmal verwendet werden.


    protected
        array
    $nonce
     = []

Wird ein Request mit einem ungültigen Nonce gesendet kann die Applikation die Verarbeitung eines Formulars oder des Requests ablehnen.

Zufallstoken für einen Request

$properties


    protected
        array
    $properties
     = []

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

$transcript


    protected
        array
    $transcript
     = []

Liste der Zugriffe

__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()

Session erstellen


    public
                    __construct() : mixed

Neues Session-Objekt mit der Lebenszeit 1 Stunde erstellen

__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()

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


    public
                    __serialize() : string

Soll eine abgeleitete Klasse nicht serialisierbar sein, so muss diese Methode überschrieben werden und eine Exception werfen.

Return values

string —

String-Repräsentation des Objektes

__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()

Deserialisierung


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

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

Parameters

$serialized : array<string|int, mixed>

__unset()

Zurücksetzen von Werten


    public
                    __unset(string $name) : mixed

Parameters

$name : string

addNonce()

Neuen Nonce erstellen


    public
                    addNonce(Nonce $nonce) : Session

Hängt einen eindeutigen Token (Nonce) in die Session ein.

Parameters

$nonce : Nonce: Nonce

Return values

Session

clearTranscripts()

Liste mit dem Verlauf der Session leeren.


    public
                    clearTranscripts() : array

Return values

array —

Liste mit allen bisherigen Transcripten

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.

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

getCurrentTranscript()

Eine Abschrift stellt Daten der aktuellen Anfrage bereit.


    public
                    getCurrentTranscript() : Transcript

Über dieses Objekt, können Werte einzelnen Schritten zugewiesen werden.

$session->getCurrentTranscript()->myValue='test';

Return values

Transcript —

Aktuelles Transcript

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

getIdentity()

Identität


    public
                    getIdentity() : Identity

Der Session zugeordneten Identität

Return values

Identity —

Identität

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

getTranscripts()

Liefert eine Liste mit dem Verlauf der Session.


    public
                    getTranscripts() : array

Return values

array —

Liste mit allen bisherigen Transcripten

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

invalidate()

Session entwerten


    public
                    invalidate() : Session

Setzt die Lebenszeit auf 0 und macht dadurch die Session ungültig. Das gleiche kann man mit setExpiration(0) erreichen.

Return values

Session —

Dieses Objekt

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

isValid()

Überprüft die Session


    public
                    isValid() : boolean

Return values

boolean —

true wenn die Session noch gültig ist

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

redeemedNonce()

Nonce entwerten


    public
                    redeemedNonce(string $token) : boolean

Entwertet einen Nonce und entfernt ihn bei Erfolg aus der Liste.

Parameters

$token : string: Eindeutiger Token

Return values

boolean —

true im Erfolgsfall, ansonsten false

setExpiration()

Ablaufdatum setzen


    public
                    setExpiration(int $time) : Session

Setzt den Zeitpunkt (timestamp), ab der Session abläuft. Der Ablauf gilt immer vom letzten Zugriff (lastAccess) auf die Session und fängt immer wieder neu zu zählen an.

Parameters

$time : int: Zeitstempel für den Ablauf der Session

Return values

Session —

Dieses Objekt

setIdentity()

Diese Methode ordnet der Session eine Identität zu.


    public
                    setIdentity(Subject $identity) : Session

Parameters

$identity : Subject

Return values

Session

validateID()

Überprüft ob der übergebene String einer gültigen Session-ID entspricht.


    public
            static        validateID(string $id) : boolean

Es wird nicht geprüft, ob es die Session ist, sondern nur ob das Format der Session übereinstimmt.

Im Standard gibt diese Methode immer true zurück.

Parameters

$id : string: Session-ID

Return values

boolean —

true wenn es eine gültige Session-ID ist

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>

validate()

Session prüfen


    protected
                    validate() : Session

Interne Methode, die überprüft ob die Session bereits abgelaufen ist.

Return values

Session —

Dieses Objekt

Session extends Alvine in package Alvine Net Session

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

LIVETIME

SERIALVERSION

SESSIONKEY

VERSION

Properties

$creationTime

$expiration

$hasAssociatedProperties

$hash

$hasVolatileProperties

$identity

$lastAccessTime

$nonce

Tags

$properties

$transcript

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

addNonce()

Parameters

Return values

clearTranscripts()

Return values

equals()

Parameters

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getCurrentTranscript()

Return values

getHashCode()

Tags

Return values

getID()

Return values

getIdentity()

Return values

getShortID()

Session extends Alvine
in package

Alvine

Net

Session