class Session extends Alvine

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

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.

SESSIONKEY

Schlüssel für eine Session

LIVETIME

Standard-Lebenszeit einer Session 1 Stunde

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 $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 integer $expiration
protected array $transcript
protected int $creationTime
protected int $lastAccessTime
protected Identity $identity

Methods

string
serialize()

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

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)

Deserialisierung

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

Session erstellen

Session
setExpiration(int $time)

Ablaufdatum setzen

Session
invalidate()

Session entwerten

Session
validate()

Session prüfen

boolean
isValid()

Überprüft die Session

addNonce(Nonce $nonce)

Neuen Nonce erstellen

boolean
redeemedNonce(string $token)

Nonce entwerten

static boolean
validateID(string $id)

ID überprüfen

Transcript
getCurrentTranscript()

Eine Abschrift stellt Daten der aktuellen Anfrage bereit.

array
getTranscripts()

Liefert eine Liste mit dem Verlauf der Session.

array
clearTranscripts()

Liste mit dem Verlauf der Session leeren.

setIdentity(Identity $identity)

Diese Methode ordnet der Session eine Identität zu.

Identity
getIdentity()

Identität

Details

at line 298
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.

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

at line 285
unserialize(string $serialization)

Deserialisierung

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte nicht direkt 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

at line 115
__construct()

Session erstellen

Neues Session-Objekt mit der Lebenszeit 1 Stunde erstellen

at line 138
Session setExpiration(int $time)

Ablaufdatum setzen

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

int $time Zeitstempel für den Ablauf der Session

Return Value

Session Dieses Objekt

at line 152
Session invalidate()

Session entwerten

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

Return Value

Session Dieses Objekt

at line 164
protected Session validate()

Session prüfen

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

Return Value

Session Dieses Objekt

at line 181
boolean isValid()

Überprüft die Session

Return Value

boolean true wenn die Session noch gültig ist

at line 196
Session addNonce(Nonce $nonce)

Neuen Nonce erstellen

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

Parameters

Nonce $nonce Nonce

Return Value

Session

at line 211
boolean redeemedNonce(string $token)

Nonce entwerten

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

Parameters

string $token Eindeutiger Token

Return Value

boolean true im Erfolgsfall, ansonsten false

at line 233
static boolean validateID(string $id)

ID überprüfen

Überprüft ob der übergebene String einer gültigen Session-ID entspricht. Es wird nicht geprüft, ob es die Session ist, sondern nur ob das Format der Session übereinstimmt.

Parameters

string $id Session-ID

Return Value

boolean true wenn es eine gültige Session-ID ist

at line 249
Transcript getCurrentTranscript()

Eine Abschrift stellt Daten der aktuellen Anfrage bereit.

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

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

Return Value

Transcript Aktuelles Transcript

at line 258
array getTranscripts()

Liefert eine Liste mit dem Verlauf der Session.

Return Value

array Liste mit allen bisherigen Transcripten

at line 267
array clearTranscripts()

Liste mit dem Verlauf der Session leeren.

Return Value

array Liste mit allen bisherigen Transcripten

at line 308
setIdentity(Identity $identity)

Diese Methode ordnet der Session eine Identität zu.

Parameters

Identity $identity Identität

at line 320
Identity getIdentity()

Identität

Der Session zugeordneten Identität

Return Value

Identity Identität