Cookie
class Cookie extends Cookie
Erweiterung der Cookies
Die Alvine\Net\Http\Environment\Cookie-Klasse erweitert das Cookie-Objekt um die Möglichkeit Cookies aus der Environment zu 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.
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. |
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 | from Cookie |
protected string | $value | Wert des Cookies | from Cookie |
protected string | $comment | from Cookie | |
protected integer | $maxage | from Cookie | |
protected integer | $expired | from Cookie | |
protected string | $path | from Cookie | |
protected string | $domain | Cookie ist auf Domain begrenzt | from Cookie |
protected boolean | $secure | Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschliesslich über https Verbindungen. | from Cookie |
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. | from Cookie |
static protected ObjectMap | $cookies |
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
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
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.
Der Konstruktor
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.
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.
Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschliesslich über https Verbindungen.
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.
Expire setzen
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.
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.
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.
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.
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,
Erstellt aus der Variable $_COOKIES ein neues Cookie-Objekt. Die Funktion behandelt auch einen Bug, der die Variable nicht aus $cookie holt, sondern die Werte aus $_SERVER["HTTP_COOKIE"] ausliest und in die Cookie-Variable speichert.
Details
in SerializableImplementation at line 122
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.
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.
in SerializableImplementation at line 252
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.
in Cookie at line 379
string
__toString()
Wrapper für String-Konvertierung
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 61
__construct(string $name)
Der Konstruktor
in Cookie at line 137
string
getName()
Name
in Cookie 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.
in Cookie 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.
in Cookie at line 188
Cookie
setSecure(boolean $value)
Setzt das Secure-Flag. Ist das Flag gesetzt = true, so gilt das Cookie ausschliesslich über https Verbindungen.
in Cookie at line 198
type
getSecure()
Gibt zurück, ob das Secureflag gesetzt ist.
in Cookie 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.
in Cookie at line 237
string
getDomain()
Aktuell gesetzte Domain auslesen
in Cookie 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.
in Cookie at line 260
string
getPath()
Gibt den Pfad zurück
in Cookie at line 269
string
getValue()
Wert auslesen
in Cookie 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.
in Cookie 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.
in Cookie 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.
in Cookie 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.
in Cookie 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.
in Cookie 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,
at line 81
static ObjectMap
getInstancesFromEnvironment()
Erstellt aus der Variable $_COOKIES ein neues Cookie-Objekt. Die Funktion behandelt auch einen Bug, der die Variable nicht aus $cookie holt, sondern die Werte aus $_SERVER["HTTP_COOKIE"] ausliest und in die Cookie-Variable speichert.