Session
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
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
Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Deserialisierung
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
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.
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.
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
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 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.
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
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.
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.
Session erstellen
Ablaufdatum setzen
Session entwerten
Session prüfen
Überprüft die Session
Nonce entwerten
ID überprüfen
Eine Abschrift stellt Daten der aktuellen Anfrage bereit.
Liefert eine Liste mit dem Verlauf der Session.
Liste mit dem Verlauf der Session leeren.
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.
in SerializableImplementation at line 193
bool
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 205
bool
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 228
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.
at line 285
void
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.
in Alvine at line 177
string
__toString()
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
echo (string) new MyObect();
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;
in Alvine at line 222
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 231
__unset(string $name)
Zurücksetzen von Werten
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;
}
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.
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;
}
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!
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();
}
in Alvine at line 376
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
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)
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.
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)) {
// ...
}
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
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();
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
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.
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.
at line 164
protected Session
validate()
Session prüfen
Interne Methode, die überprüft ob die Session bereits abgelaufen ist.
at line 181
boolean
isValid()
Überprüft die Session
at line 196
Session
addNonce(Nonce $nonce)
Neuen Nonce erstellen
Hängt einen eindeutigen Token (Nonce) in die Session ein.
at line 211
boolean
redeemedNonce(string $token)
Nonce entwerten
Entwertet einen Nonce und entfernt ihn bei Erfolg aus der Liste.
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.
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';
at line 258
array
getTranscripts()
Liefert eine Liste mit dem Verlauf der Session.
at line 267
array
clearTranscripts()
Liste mit dem Verlauf der Session leeren.
at line 308
setIdentity(Identity $identity)
Diese Methode ordnet der Session eine Identität zu.
at line 320
Identity
getIdentity()
Identität
Der Session zugeordneten Identität