class Cookie extends Alvine

Cookie

Die Cookie-Klasse kapselt den Zugriff und das Erstellen und auslesen von Daten die mittels Cooie übertragen werden.

$cookie = new Cookie('A','b');
//Neues Cookie mit dem Namen A und dem Wert b erstellen.

Um Sicherheits- und Datenschutzprobleme zu vermeiden, wird ein Client ein Cookie ablehnen, wenn einer der folgende Bedingungen nicht erfüllt ist:

  • Der Wert des Pfades ist kein Prefix der Anfrage-URI
  • Der Wert der Domain enthält keine Punkt, oder startet nicht mit einem Punkt
  • Der Wert für den Host stimmt nicht überein
  • Der Host ist über einen FQDN (keine IP Adresse) spezifiziert und hat die Form HD, wobei D die Domain und H ein String ist, der einen oder mehrere Punkte enthält.

Für den Zugriff auf die $_COOKIE Werte des aktuellen Requests steht die abgeleitete Klasse see Alvine\Net\Http\Environment\Cookie zur Verfügung.

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 string $name Name des Cookies
protected string $value Wert des Cookies
protected string $comment
protected integer $maxage
protected integer $expired
protected string $path
protected string $domain Cookie ist auf Domain begrenzt
protected boolean $secure Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschliesslich über https Verbindungen.
protected boolean $httpOnly Dieses spezielle Feature erlaubt es Cookies nur auf HTTP-Anfragen einzuschränken und das Cookie nicht per Javascript verfügbar zu machen. Dieses Sicherheitsfeature kann dazu beitragen XSS-Angriffe abzuwenden.

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

Wrapper für String-Konvertierung

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(string $name, string $value)

Konstruktor

string
getName()

Name

setValue(string $value)

Setzt einen neuen Wert.

setHttpOnly(boolean $value)

Dieses Spezielle Feature erlaubt es Cookies nur auf HTTP-Anfragen einzuschränken und das Cookie nicht per Javascript verfügbar zu machen. Dieses Sicherheitsfeature kann dazu beitragen XSS-Angriffe abzuwenden.

boolean
getHttpOnly()

Dieses Spezielle Feature erlaubt es Cookies nur auf HTTP-Anfragen einzuschränken und das Cookie nicht per Javascript verfügbar zu machen. Dieses Sicherheitsfeature kann dazu beitragen XSS-Angriffe abzuwenden.

setSecure(boolean $value)

Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschliesslich über https Verbindungen.

type
getSecure()

Gibt zurück, ob das Secureflag gesetzt ist.

setDomain(string $domain)

Setzen die Domain, für die das Cookie zur Verfügung steht.

string
getDomain()

Aktuell gesetzte Domain auslesen

setPath(string $path)

Setzt den Pfad. Ist der Pfad auf / gesetzt, so ist das Cookie in der ganzen Domain verfügbar. Wird der Wert auf /foo/ gesetzt, so ist das Cookie nur unter /foo/ verfügbar.

string
getPath()

Gibt den Pfad zurück

string
getValue()

Wert auslesen

setExpirationDelta(integer $seconds, integer $minute = 0, integer $hour = 0, integer $days = 0)

Expire setzen

setExpiration(integer $seconds)

Setzt den Zeitpunkt ab dem das Cookie nicht mehr gültig ist. Ein Wert von 0 bedeutet, das das Cookie nur für den Zeitraum der Session gilt.

integer
getExpiration()

Liefert den Zeitpunkt nach dem der Client den Cookie als ungültig erklären soll. Ein Wert von 0 bedeutet, das das Cookie nur für den Zeitraum der Session gilt.

setMaxAge(integer $seconds)

Setzt die Anzahl an Sekunden, ab dem das Cookie nicht mehr gültig ist. Ein Wert von 0 bedeutet, das das Cookie nur für den Zeitraum der Session gilt.

integer
getMaxAge()

Liefert die Anzahl der Sekunden nach dem der Client den Cookie als ungültig erklären soll. Ein Wert von 0 bedeutet, das das Cookie nur für den Zeitraum der Session gilt.

setDeleted()

Setzt das Cookie auf gelöscht. Das Cookie ist damit nicht gelöscht, sondern vielmehr wird die Expiration auf die Vergangenheit gesetzt und der Wert auf deleted,

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

at line 379
string __toString()

Wrapper für String-Konvertierung

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 123
__construct(string $name, string $value)

Konstruktor

Parameters

string $name Name
string $value Wert

at line 137
string getName()

Name

Return Value

string Name des Cookie

at line 148
Cookie setValue(string $value)

Setzt einen neuen Wert.

Parameters

string $value Wert

Return Value

Cookie Dieses Objekt

at line 163
Cookie setHttpOnly(boolean $value)

Dieses Spezielle Feature erlaubt es Cookies nur auf HTTP-Anfragen einzuschränken und das Cookie nicht per Javascript verfügbar zu machen. Dieses Sicherheitsfeature kann dazu beitragen XSS-Angriffe abzuwenden.

Parameters

boolean $value Wert

Return Value

Cookie Dieses Objekt

at line 176
boolean getHttpOnly()

Dieses Spezielle Feature erlaubt es Cookies nur auf HTTP-Anfragen einzuschränken und das Cookie nicht per Javascript verfügbar zu machen. Dieses Sicherheitsfeature kann dazu beitragen XSS-Angriffe abzuwenden.

Return Value

boolean Wert

at line 188
Cookie setSecure(boolean $value)

Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschliesslich über https Verbindungen.

Parameters

boolean $value Wert

Return Value

Cookie

at line 198
type getSecure()

Gibt zurück, ob das Secureflag gesetzt ist.

Return Value

type

at line 222
Cookie setDomain(string $domain)

Setzen die Domain, für die das Cookie zur Verfügung steht.

Einige Browser unterstützen hier die Angabe ohne www, also example.com, allerdings wird nach Standard RFC 2109 der volle FDQN verlangt: www.example.com oder ein Punkt als erstes Zeichen für alle Subdomain .example.com

Wird .example.com definirt gilt das Cookie allerdings nicht für example.com selber.

In der neuen RFC 6265 wird der führende Punkt ignoriert und example.com gilt für alle Domains inkl. der Subdomains.

Parameters

string $domain Domain

Return Value

Cookie Dieses Objekt

at line 237
string getDomain()

Aktuell gesetzte Domain auslesen

Return Value

string Domain

at line 250
Cookie setPath(string $path)

Setzt den Pfad. Ist der Pfad auf / gesetzt, so ist das Cookie in der ganzen Domain verfügbar. Wird der Wert auf /foo/ gesetzt, so ist das Cookie nur unter /foo/ verfügbar.

Parameters

string $path Pfad

Return Value

Cookie Dieses Objekt

at line 260
string getPath()

Gibt den Pfad zurück

Return Value

string

at line 269
string getValue()

Wert auslesen

Return Value

string Wert

at line 290
Cookie setExpirationDelta(integer $seconds, integer $minute = 0, integer $hour = 0, integer $days = 0)

Expire setzen

Zur einfachen Angabe der Zeit, kann über diese Bequemlichkeitsfunktion die Ablaufzeit angegeben werden. Zu der übergebenen Zeit wird das Ergebnis von time() addiert.

Parameters

integer $seconds Sekunden
integer $minute Minuten
integer $hour Stunden
integer $days Tage

Return Value

Cookie Dieses Objekt

See also

Cookie::setExpiration

at line 315
Cookie setExpiration(integer $seconds)

Setzt den Zeitpunkt ab dem das Cookie nicht mehr gültig ist. Ein Wert von 0 bedeutet, das das Cookie nur für den Zeitraum der Session gilt.

Bei dem Wert handelt es sich um ein Unix-Timestamp für die Zeit ab der das Cookie nicht mehr gültig ist.

Für eine Gültigkeit in Sekunden siehe Max-Age.

Parameters

integer $seconds Sekunden

Return Value

Cookie Dieses Objekt

at line 327
integer getExpiration()

Liefert den Zeitpunkt nach dem der Client den Cookie als ungültig erklären soll. Ein Wert von 0 bedeutet, das das Cookie nur für den Zeitraum der Session gilt.

Return Value

integer Zeit in Sekunden ab 1970

at line 347
Cookie setMaxAge(integer $seconds)

Setzt die Anzahl an Sekunden, ab dem das Cookie nicht mehr gültig ist. Ein Wert von 0 bedeutet, das das Cookie nur für den Zeitraum der Session gilt.

Bei dem Wert handelt es sich um ein Unix-Timestamp für die Zeit ab der das Cookie nicht mehr gültig ist.

Für einen Zeitpunkt siehe Expire.

Parameters

integer $seconds Sekunden

Return Value

Cookie Dieses Objekt

at line 359
integer getMaxAge()

Liefert die Anzahl der Sekunden nach dem der Client den Cookie als ungültig erklären soll. Ein Wert von 0 bedeutet, das das Cookie nur für den Zeitraum der Session gilt.

Return Value

integer Sekunden

at line 368
setDeleted()

Setzt das Cookie auf gelöscht. Das Cookie ist damit nicht gelöscht, sondern vielmehr wird die Expiration auf die Vergangenheit gesetzt und der Wert auf deleted,