Documentation

Request extends Request
in package

Alvine

Net

Http

Environment

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;

Constants

APIVERSION = 1: Version der API-Version der Klasse.
HTTP_1_0 = 'HTTP/1.0': Protokoll 1.0
HTTP_1_1 = 'HTTP/1.1': Standardprotokoll 1.1
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

$body : Body
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$header : Header
$properties : array

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: Request
__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: Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
__unserialize() : void
__unset() : mixed: Zurücksetzen von Werten
addHeader() : HTTPMessage: Setzt einen Eintrag im Header
determineCharset() : string: Zeichensatz ermitteln
determineEncoding() : integer: Unterstützes Encoding des Clients
determineLocale() : Locale: Ermitteln der vom Client unterstützen Locale. Wird keine Locale definiert, so wird das Ergebnis von \Alvine\I18n\Locale::getDefault zurückgegeben.
determineMediaType() : MediaType: Passenden MediaType ermitteln
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.
getBody() : Body: Body
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.
getData() : string: Daten aufbereiten
getHashCode() : string: Die Methode Alvine::getID() verwenden!
getHeader() : Header: Headers
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.
getInstanceFromData() : mixed: Request-Objekt erstellen
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.
getUploadedFiles() : FileList: Übertragene Dateien als FileList Objekt holen
getURL() : URI: URL des Requests
getValueFromCookie() : mixed: Die Werte werden aus der globalen Variable $_COOKIE ausgelesen.
getValueFromPost() : mixed: Die Werte werden aus der globalen Variable $_POST ausgelesen.
getValueFromQuery() : mixed: Die Werte werden aus der globalen Variable $_GET ausgelesen.
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
isAcceptedLocale() : bool: Prüfen ob die entsprechende Locale unterstützt wird
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.
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
getValueFromRequest() : mixed: Werte aus einer superglobalen Variable auslesen

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

HTTP_1_0

Protokoll 1.0


    public
        mixed
    HTTP_1_0
    = 'HTTP/1.0'

HTTP_1_1

Standardprotokoll 1.1


    public
        mixed
    HTTP_1_1
    = 'HTTP/1.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

$body


    protected
        Body
    $body
     = null

Inhalt

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

$header


    protected
        Header
    $header
     = null

Header

$properties


    protected
        array
    $properties
     = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

__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

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

Request


    public
                    __construct() : mixed

Neuen Request aus dem Environment anlegen.

__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

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.

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

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette


    public
                    __toString() : string

echo (string) new MyObect();

Return values

string —

Daten des Objekts

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

__unset()

Zurücksetzen von Werten


    public
                    __unset(string $name) : mixed

Parameters

$name : string

addHeader()

Setzt einen Eintrag im Header


    public
                    addHeader(string $name, string $value) : HTTPMessage

Parameters

$name : string: Name
$value : string: Wert

Return values

HTTPMessage —

Dieses Objekt

determineCharset()

Zeichensatz ermitteln


    public
                    determineCharset() : string

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

Return values

string —

Zeichensatz

determineEncoding()

Unterstützes Encoding des Clients


    public
                    determineEncoding() : integer

Return values

integer —

Encoding (im Standard gzip oder original)

determineLocale()

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


    public
                    determineLocale([Locale $locale = null ]) : Locale

Parameters

$locale : Locale = null: Gewünschte Locale

Return values

Locale —

ausgewählte Locale

determineMediaType()

Passenden MediaType ermitteln


    public
                    determineMediaType([string $mediatype = 'text/html' ]) : MediaType

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

$mediatype : string = 'text/html': Vorgegebener Wert

Return values

MediaType —

Mediatype

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.

getBody()

Body


    public
                    getBody() : Body

Gibt den Inhalt zurück

Return values

Body —

Body

getClass()

Name der Klasse


    public
                    getClass() : string

class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();

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

Return values

Alvine

getClosure()

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

Return values

Closure

getData()

Daten aufbereiten


    public
                    getData() : string

Daten für die Übergabe an den Socket aufbereiten

Return values

string —

Zeichenkette die den Header enthält

getHashCode()

Die Methode Alvine::getID() verwenden!


    public
                    getHashCode() : string

Return values

string —

Hashwert des Objektes

getHeader()

Headers


    public
                    getHeader() : Header

Gibt alle Header als Header-Objekt zurück

Return values

Header —

Header

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

getInstanceFromData()

Request-Objekt erstellen


    public
            static        getInstanceFromData(string $data) : mixed

Eine Instanz aus den übergebenen Daten erstellen

Parameters

$data : string

getShortID()

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

string

getUploadedFiles()

Übertragene Dateien als FileList Objekt holen


    public
                    getUploadedFiles([string|null $name = null ]) : FileList

Parameters

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

Return values

FileList —

Dateiliste

getURL()

URL des Requests


    public
                    getURL([boolean $relative = true ]) : URI

Parameters

$relative : boolean = true: Relative oder Absolute URI

Return values

URI

getValueFromCookie()

Die Werte werden aus der globalen Variable $_COOKIE ausgelesen.


    public
                    getValueFromCookie(string $key[, mixed $default = null ][, string $type = 'string' ]) : mixed

Parameters

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

Return values

mixed —

Wert oder $default

getValueFromPost()

Die Werte werden aus der globalen Variable $_POST ausgelesen.


    public
                    getValueFromPost(string $key[, mixed $default = null ][, string $type = 'string' ]) : mixed

Parameters

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

Return values

mixed —

Wert oder $default

getValueFromQuery()

Die Werte werden aus der globalen Variable $_GET ausgelesen.


    public
                    getValueFromQuery(string $key[, mixed $default = null ][, string $type = 'string' ]) : mixed

Parameters

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

Return values

mixed —

Wert oder $default

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

isAcceptedLocale()

Prüfen ob die entsprechende Locale unterstützt wird


    public
                    isAcceptedLocale(Locale $locale[, boolean $strict = false ]) : bool

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
$strict : boolean = false: Strikt

Return values

bool

isCallable()

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

boolean

propertyExists()

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

boolean

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

Return values

array<string|int, mixed>

getValueFromRequest()

Werte aus einer superglobalen Variable auslesen


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

Parameters

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

Return values

mixed —

Wert nach übergebenen Typen

Request extends Request in package Alvine Net Http Environment

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

HTTP_1_0

HTTP_1_1

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$body

$hasAssociatedProperties

$hash

$hasVolatileProperties

$header

$properties

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

addHeader()

Parameters

Return values

determineCharset()

Return values

determineEncoding()

Return values

determineLocale()

Parameters

Return values

determineMediaType()

Parameters

Return values

equals()

Parameters

Return values

getBody()

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getData()

Return values

getHashCode()

Tags

Request extends Request
in package

Alvine

Net

Http

Environment