class Request extends Request

Diese Klasse bildet den Request, der vom aufrufenden Webserver übergeben wird, ab.

Die notwendigen Informationen werde dabei aus den globalen Variablen $_SERVER, $_ENV, $_POST, $_GET, $_FILES und $_COOKIE generiert.

$request = new \Alvine\Net\Http\Environment\Request();
echo (string) $request;

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.

HTTP_1_0

Protokoll 1.0

HTTP_1_1

Standardprotokoll 1.1

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected Header $header from HTTPMessage
protected Body $body from HTTPMessage

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 Request::getData() für die Verwendung im Cast.

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

Request

addHeader(string $name, string $value)

Setzt einen Eintrag im Header

getHeader()

Headers

getBody()

Body

string
getData()

Daten aufbereiten

from Request
static Object
getInstanceFromData(mixed $data)

Request-Objekt erstellen

from Request
string
determineCharset()

Zeichensatz ermitteln

determineMediaType(string $mediatype = 'text/html')

Passenden MediaType ermitteln

integer
determineEncoding()

Unterstützes Encoding des Clients

boolean
isAcceptedLocale(Locale $locale, boolean $strict = false)

Prüfen ob die entsprechende Locale unterstützt wird

determineLocale(Locale $locale = null)

Ermitteln der vom Client unterstützen Locale. Wird keine Locale definiert, so wird das Ergebnis von \Alvine\I18n\Locale::getDefault zurückgegeben.

mixed
getValueFromPost(string $key, mixed $default = null, string $type = 'string')

Die Werte werden aus der globalen Variable $_POST ausgelesen.

mixed
getValueFromQuery(string $key, mixed $default = null, string $type = 'string')

Die Werte werden aus der globalen Variable $_GET ausgelesen.

mixed
getValueFromCookie(string $key, mixed $default = null, string $type = 'string')

Die Werte werden aus der globalen Variable $_COOKIE ausgelesen.

mixed
getValueFromRequest(type $array, string $key, mixed $default, string $type)

Werte aus einer superglobalen Variable auslesen

getUploadedFiles(string|null $name = null)

Übertragene Dateien als FileList Objekt holen

URI
getURL(boolean $relative = true)

URL des Requests

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

in Request at line 118
string __toString()

Wrapper für Request::getData() für die Verwendung im Cast.

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

Request

Neuen Request aus dem Environment anlegen.

in HTTPMessage at line 85
HTTPMessage addHeader(string $name, string $value)

Setzt einen Eintrag im Header

Parameters

string $name Name
string $value Wert

Return Value

HTTPMessage Dieses Objekt

in HTTPMessage at line 97
Header getHeader()

Headers

Gibt alle Header als Header-Objekt zurück

Return Value

Header Header

in HTTPMessage at line 108
Body getBody()

Body

Gibt den Inhalt zurück

Return Value

Body Body

in Request at line 75
string getData()

Daten aufbereiten

Daten für die Übergabe an den Socket aufbereiten

Return Value

string Zeichenkette die den Header enthält

in Request at line 129
static Object getInstanceFromData(mixed $data)

Request-Objekt erstellen

Eine Instanz aus den übergebenen Daten erstellen

Parameters

mixed $data Daten

Return Value

Object Erstellte Instanz

at line 89
string determineCharset()

Zeichensatz ermitteln

Es wird geprüft, ob der Client UTF-8 versteht. Ist dies nicht der Fall, so wird ein anderer Zeichensatz ermittelt.

Return Value

string Zeichensatz

at line 126
MediaType determineMediaType(string $mediatype = 'text/html')

Passenden MediaType ermitteln

Die Methode prüft welchen Medientyp der Client bevorzugt. Wird der Parameter $mediatype übergeben und wird dieser vom Client unterstützt, so wird dieser zurückgegeben.

Wird dieser Medientyp nicht unterstützt wird der vom Client bevorzugte Medientyp zurückgegeben. Definiert der Client kein Header-Field mit einem Mediatypen wird der Mimetype des Parameters $mediatype zurückgegeben.

Wird weder ein Accepted-Field noch ein $mediatype übergeben, so wird das Ergebnis von \Alvine\Types\MediaType::getDefaultMimeType() zurückgegeben.

Beim Aufrufmuss geprüft werden ob der zurückgegebene MediaType von der Anwendung unterstützt wird.

Parameters

string $mediatype Vorgegebener Wert

Return Value

MediaType Mediatype

at line 146
integer determineEncoding()

Unterstützes Encoding des Clients

Return Value

integer Encoding (im Standard gzip oder original)

at line 176
boolean isAcceptedLocale(Locale $locale, boolean $strict = false)

Prüfen ob die entsprechende Locale unterstützt wird

Bei der einfachen Prüfung wird zuerst die komplette Lokale geprüft und dann die Sprache alleine. Bei der strikten Prüfung wird hingegen nur die Locale geprüft

Wird die Funktion mit de aufgerufen, so bedeutet dies:

strict true false de-AT false true

Parameters

Locale $locale
boolean $strict Strikt

Return Value

boolean

at line 197
Locale determineLocale(Locale $locale = null)

Ermitteln der vom Client unterstützen Locale. Wird keine Locale definiert, so wird das Ergebnis von \Alvine\I18n\Locale::getDefault zurückgegeben.

Parameters

Locale $locale Gewünschte Locale

Return Value

Locale ausgewählte Locale

at line 228
mixed getValueFromPost(string $key, mixed $default = null, string $type = 'string')

Die Werte werden aus der globalen Variable $_POST ausgelesen.

Parameters

string $key Schlüssel
mixed $default Standardwert, wenn der Schlüssel nicht definiert
string $type Type auf den geprüft wird (mus in der Klasse Type definiert sein)

Return Value

mixed Wert oder $default

at line 242
mixed getValueFromQuery(string $key, mixed $default = null, string $type = 'string')

Die Werte werden aus der globalen Variable $_GET ausgelesen.

Parameters

string $key Schlüssel
mixed $default Standardwert, wenn der Schlüssel nicht definiert
string $type Type auf den geprüft wird (mus in der Klasse Type definiert sein)

Return Value

mixed Wert oder $default

at line 256
mixed getValueFromCookie(string $key, mixed $default = null, string $type = 'string')

Die Werte werden aus der globalen Variable $_COOKIE ausgelesen.

Parameters

string $key Schlüssel
mixed $default Standardwert, wenn der Schlüssel nicht definiert
string $type Type auf den geprüft wird (mus in der Klasse Type definiert sein)

Return Value

mixed Wert oder $default

at line 270
protected mixed getValueFromRequest(type $array, string $key, mixed $default, string $type)

Werte aus einer superglobalen Variable auslesen

Parameters

type $array Verwendetes Array (GET, POST oder COOKIE)
string $key Schlüssel
mixed $default Standardwert, wenn der Schlüssel nicht definiert
string $type Type auf den geprüft wird (mus in der Klasse Type definiert sein)

Return Value

mixed Wert nach übergebenen Typen

at line 285
FileList getUploadedFiles(string|null $name = null)

Übertragene Dateien als FileList Objekt holen

Parameters

string|null $name Name aus dem name-Attribute des HTML-Input-Tags, oder null für alle übertragenen Dateien

Return Value

FileList Dateiliste

at line 296
URI getURL(boolean $relative = true)

URL des Requests

Parameters

boolean $relative Relative oder Absolute URI

Return Value

URI