Cookie
extends Alvine
in package
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.
Tags
Table of Contents
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
- $comment : string
- $domain : string
- Cookie ist auf Domain begrenzt
- $expired : integer
- $hasAssociatedProperties : boolean
- $hash : string
- Eindeutige ID
- $hasVolatileProperties : boolean
- $httpOnly : boolean
- 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.
- $maxage : integer
- $name : string
- Name des Cookies
- $path : string
- $properties : array
- $sameSite : string
- Cookie ist auf Domain begrenzt
- $secure : boolean
- Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschließlich über https Verbindungen.
- $value : string
- Wert des Cookies
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
- Konstruktor
- __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
- Wrapper für String-Konvertierung
- __unserialize() : void
- __unset() : mixed
- Zurücksetzen von Werten
- 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.
- getDomain() : string
- Aktuell gesetzte Domain auslesen
- getExpiration() : integer
- 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.
- getHashCode() : string
- Die Methode Alvine::getID() verwenden!
- getHttpOnly() : boolean
- 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.
- 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.
- getMaxAge() : integer
- 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.
- getName() : string
- Name
- getPath() : string
- Gibt den Pfad zurück
- getSameSite() : string
- getSecure() : bool
- Gibt zurück, ob das Secureflag gesetzt ist.
- 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.
- getValue() : string
- Wert auslesen
- 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.
- propertyExists() : boolean
- Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
- setDeleted() : mixed
- 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,
- setDomain() : Cookie
- Setzen die Domain, für die das Cookie zur Verfügung steht.
- setExpiration() : Cookie
- 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.
- setExpirationDelta() : Cookie
- Expire setzen
- setHttpOnly() : Cookie
- 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.
- setMaxAge() : Cookie
- 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.
- setPath() : Cookie
- 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.
- setSameSite() : Cookie
- setSecure() : Cookie
- Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschliesslich über https Verbindungen.
- setValue() : Cookie
- Setzt einen neuen Wert.
- checkAndAdjustSerialisation() : array<string|int, mixed>
- Dealing with versions
Constants
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
Properties
$comment
protected
string
$comment
= null
Kommentar
$domain
Cookie ist auf Domain begrenzt
protected
string
$domain
= null
Domain
$expired
protected
integer
$expired
= 0
Zeitstempel des Ablaufes in Sekunden
$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)
$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.
protected
boolean
$httpOnly
= false
Wert
$maxage
protected
integer
$maxage
= 0
Sekunden seit 1970
$name
Name des Cookies
protected
string
$name
= null
Name
$path
protected
string
$path
= '/'
Pfad
$properties
protected
array
$properties
= []
Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.
$sameSite
Cookie ist auf Domain begrenzt
protected
string
$sameSite
= null
Domain
Tags
$secure
Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschließlich über https Verbindungen.
protected
boolean
$secure
= false
Sicherheit
$value
Wert des Cookies
protected
string
$value
= null
Wert
Methods
__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
Tags
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()
Konstruktor
public
__construct(string $name, string $value) : mixed
Parameters
- $name : string
-
Name
- $value : string
-
Wert
__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
Tags
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.
Tags
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()
Wrapper für String-Konvertierung
public
__toString() : string
Return values
string —Wert des Cookies
__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
Tags
__unset()
Zurücksetzen von Werten
public
__unset(string $name) : mixed
Parameters
- $name : string
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();
Tags
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
Tags
Return values
AlvinegetClosure()
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
Tags
Return values
ClosuregetDomain()
Aktuell gesetzte Domain auslesen
public
getDomain() : string
Return values
string —Domain
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.
public
getExpiration() : integer
Return values
integer —Zeit in Sekunden ab 1970
getHashCode()
Die Methode Alvine::getID() verwenden!
public
getHashCode() : string
Tags
Return values
string —Hashwert des Objektes
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.
public
getHttpOnly() : boolean
Return values
boolean —Wert
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
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.
public
getMaxAge() : integer
Return values
integer —Sekunden
getName()
Name
public
getName() : string
Return values
string —Name des Cookie
getPath()
Gibt den Pfad zurück
public
getPath() : string
Return values
stringgetSameSite()
public
getSameSite() : string
Return values
stringgetSecure()
Gibt zurück, ob das Secureflag gesetzt ist.
public
getSecure() : bool
Return values
boolgetShortID()
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
stringgetValue()
Wert auslesen
public
getValue() : string
Return values
string —Wert
hasAssociatedProperties()
Check if the object has associative properties
public
hasAssociatedProperties() : boolean
Tags
Return values
booleanhasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
public
hasVolatileProperties() : boolean
Tags
Return values
booleanisCallable()
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
booleanpropertyExists()
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
booleansetDeleted()
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,
public
setDeleted() : mixed
setDomain()
Setzen die Domain, für die das Cookie zur Verfügung steht.
public
setDomain(string $domain) : Cookie
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
- $domain : string
-
Domain
Tags
Return values
Cookie —Dieses Objekt
setExpiration()
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.
public
setExpiration(integer $seconds) : Cookie
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
- $seconds : integer
-
Sekunden
Return values
Cookie —Dieses Objekt
setExpirationDelta()
Expire setzen
public
setExpirationDelta(integer $seconds[, integer $minute = 0 ][, integer $hour = 0 ][, integer $days = 0 ]) : Cookie
Zur einfachen Angabe der Zeit, kann über diese Bequemlichkeitsfunktion die Ablaufzeit angegeben werden. Zu der übergebenen Zeit wird das Ergebnis von time() addiert.
Parameters
- $seconds : integer
-
Sekunden
- $minute : integer = 0
-
Minuten
- $hour : integer = 0
-
Stunden
- $days : integer = 0
-
Tage
Tags
Return values
Cookie —Dieses Objekt
setHttpOnly()
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.
public
setHttpOnly(boolean $value) : Cookie
Parameters
- $value : boolean
-
Wert
Return values
Cookie —Dieses Objekt
setMaxAge()
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.
public
setMaxAge(integer $seconds) : Cookie
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
- $seconds : integer
-
Sekunden
Return values
Cookie —Dieses Objekt
setPath()
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.
public
setPath(string $path) : Cookie
Parameters
- $path : string
-
Pfad
Return values
Cookie —Dieses Objekt
setSameSite()
public
setSameSite(string|null $sameSite) : Cookie
Parameters
- $sameSite : string|null
Return values
CookiesetSecure()
Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschliesslich über https Verbindungen.
public
setSecure(boolean $value) : Cookie
Parameters
- $value : boolean
-
Wert
Return values
CookiesetValue()
Setzt einen neuen Wert.
public
setValue(string $value) : Cookie
Parameters
- $value : string
-
Wert
Return values
Cookie —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