class RequestHeader extends Header

RequestHeaders

Die Spezialisierung für den Request erweitert die Headerklasse um Methode, Protokoll und URI.

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.

UPPERCASE

Großbuchstaben

LOWERCASE

Kleinbuchstaben

CONTENT_DISPOSITION

Mit diesem nicht standardisierten und als gefährlich eingestuften Feld kann der Server für bestimmte MIME-Typen Downloadfenster erzeugen und einen Dateinamen vorschlagen.

CONTENT_TYPE

MIME-Typ des Bodys

CONTENT_LENGTH

Länge des Bodys in Bytes

CONTENT_MD5

Eine Base64-codierte MD5-Checksume des Bodys

DATE

Datum und Zeit zum Sendezeitpunkt

CONNECTION

Welchen Typ von Verbindung der Browser bevorzugt

CACHE_CONTROL

Wird genutzt, um Optionen festzulegen, denen durch alle Caching-Mechanismen entlang der Anfrage-/Antwort-Kette Folge geleistet werden muss

PRAGMA

Das Feld Pragma enthält Optionen, die möglicherweise nur von einigen Implementationen verstanden werden und sich an alle Glieder in der Frage-Antwort-Kette richten

VIA

Gibt dem Server Informationen über Proxys im Übertragungsweg

WARNING

Allgemeine Warnungen über den Umgang mit dem Body oder den Body selbst

ACCEPT

Welche Dateitypen der Browser verarbeiten kann.

ACCEPT_CHARSET

Welche Zeichensätze der Browser anzeigen kann und somit empfangen möchte

ACCEPT_DATETIME

Akzeptierte Dateiversion bis zum Datum X

ACCEPT_ENCODING

Welche komprimierten Formate der Browser unterstützt

ACCEPT_LANGUAGE

Welche Sprachen der Browser akzeptiert

AUTHORIZATION

Authentifizierungsdaten für HTTP-Authentifizierungsverfahren

COOKIE

ein HTTP-Cookie, das zuvor vom Server mit Set-Cookie gesetzt wurde

EXPECT

Zeigt, welches Verhalten der Client vom Server erwartet

FROM_

E-mail-Adresse des Nutzers, der die Anfrage stellte (heute unüblich)

HOST

Domain-Name des Servers, zwingend vorgeschrieben seit HTTP/1.1 und nötig für namensbasierte Hosts.

IF_MATCH

Aktion nur durchführen, falls der gesendete Code mit dem auf dem Server vorhandenen Code übereinstimmt.

IF_MODIFIED_SINCE

Erlaubt dem Server, den Statuscode 304 Not Modified zu senden, falls sich seit dem angegebenen Zeitpunkt nichts verändert hat.

IF_NONE_MATCH

Erlaubt dem Server bei unverändertem Inhalt (verifiziert durch ETags) den Statuscode 304 Not Modified als Antwort.

IF_RANGE

Falls der Client einen Teil einer Datei vom Server im Cache liegen hat, die sich auf dem Server nicht verändert hat, nur den fehlenden Rest senden; ansonsten ganze Datei schicken.

IF_UNMODIFIED_SINCE

Nur dann die Seite senden, falls diese seit dem angegebenen Zeitpunkt nicht geändert wurde.

MAX_FORWARDS

Begrenzt die Anzahl der möglichen Weiterleitungen durch Proxys oder Gateways

PROXY_AUTHORIZATION

Im Feld Proxy-Authorization können Autorisierungsdaten für Proxys mit Autorisierungszwang eingebettet werden.

RANGE

Enthält eine Bereichsangabe für den Bereich, den der Client vom Server anfordert.

REFERER

Im Feld Referer ist der URI der verweisenden Seite enthalten

TE

Welche Formate der Client annehmen kann

UPGRADE

Vorschlag an den Server, ein anderes Protokoll zu nutzen

USER_AGENT

Der User-Agent-String des Clients. In ihm stehen Informationen über den Client.

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 $keyValueSeparator from Map
protected string $entrySeparator from Map
static protected array $headerMap Einige Header folgen nicht dem Schema von Groß-/Kleinschreibung und müssen gesondert behandelt werden. Diese Map definiert diese Sonderfälle. from Header
protected string $protocol
protected string $method
protected URI $uri

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

Gibt den Inhalt der Map als Zeichenkette zurück, dabei werden die Schlüssel und Werte durch das definiertes Trennzeichen : und die einzelnen Einträge der Map durch ein Komma getrennt.

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

Neuer Header

from Header
normalize(array $array)

Werte überprüfen

from Map
mixed
normalizeValue(string $key, mixed $value)

Bearbeitung des Wertes

from Header
Map
setKeyValueSeparator(string $separator)

Setzt das Trennzeichen für die __toString Methode

from Map
Map
setEntrySeparator(string $separator)

Setzt das Trennzeichen für die __toString Methode

from Map
Map
clear()

Leert alle Einträge aus der Map

from Map
boolean
containsKey(string $key)

Prüft ob es einen Eintrag mit dem Schlüssel gibt und dieser einen Wert !== null hat.

from Map
boolean
containsValue(mixed $value)

Prüft ob der übergebene Wert in der Map enthalten ist.

from Map
Map
append(Map|array $map)

Map oder Array anhängen

from Map
Map
setValue(string $key, mixed $value)

Wert setzen

from Map
mixed
getValue(string $key, mixed $default = null)

Gibt den Wert des Schlüssels in der Map zurück.

from Map
Map
remove(string $key)

Löscht den Eintrag mit dem übergebenen Schlüssel aus der Map

from Map
Map
removeValue(simple $value)

Entfernt alle Einträge, die den übergebenen Wert haben.

from Map
int
count()

Ermittelt die Anzahl der Einträge in der Map

from Map
static array
prepareOutput(array $properties)

Ausgabe vorbereiten

from Map
mixed
current()

Wert des aktuellen Objektes

from Map
mixed
key()

Schlüssel des aktuellen Elements zurückgeben

from Map
mixed
next()

Den internen Zeiger der Map auf den nächsten Wert setzen.

from Map
mixed
rewind()

Zurücksetzen des internen Zeigers der Map auf den ersten Eintrag

from Map
boolean
valid()

Prüft ob der interne Zeiger auf ein gültiges Element der Map zeigt.

from Map
Map
normalizeKey(int $mode)

Wandelt die Schlüssel in Großbuchstaben oder Kleinbuchstaben um.

from Map
Map
each(Closure $callback, string $filter = null)

Durchläuft alle Einträge der Map und ruft die entsprechende Funktion auf. Besonders in Zusammenhang mit den anonymen Funktionen lassen sich so sehr effiziente Konvertierungen durchführen.

from Map
offsetUnset(mixed $key)

Implementierung des Array-Interfaces

from Map
offsetSet(mixed $key, mixed $value)

Implementierung des Array-Interfaces

from Map
offsetGet(mixed $key)

Implementierung des Array-Interfaces

from Map
boolean
offsetExists(mixed $key)

Implementierung des Array-Interfaces

from Map
Map
getIntersection(HierarchicalString|string $filter)

Teilschlüssel holen

from Map
Map
getIntersectionGroups(HierarchicalString|string $filter, integer|null $level = null)

Teilmengen in Gruppen

from Map
array
toArray()

Werte als Array

from Map
string
asJson()

Json-Zeichenkette

from Map
array
asArray()

Inhalt des Dataset als Array

from Map
mixed
jsonSerialize()

Implementierung des JsonSerializable Interfaces. Ein Dataset gibt auf oberster Ebene immer ein Array zurück.

from Map
add(string $name, string $value)

Header hinzufügen

from Header
setContentLength(string $value)

Die Anzahl an Bytes für den Requests setzen

from Header
setDate(DateTime $dateTime, $timezone = null)

Datum setzen

from Header
setFirstLine(string $line)

Erste Zeile setzen

parseData(string $data)

Daten parsen

from Header
static Object
getInstanceFromData(mixed $data)

Parst eine Zeichenkette und gibt ein Header-Objekt zurück

from Header
setAcceptCharset(string $value)

Setzt den akzeptierten Zeichensatz

setCookies(ObjectMap $cookies)

Cookies setzen

MIMEType|null
getContentType()

Inhaltstyp

setProtocol(string $protocol)

Setzt das Protokoll.

setMethod(string $method)

Eine der gültigen Methoden setzen

setURI(URI $uri)

Setzen der URI

string
getMethod()

Die Methode des Requests

string
getProtocol()

Holt das Protokoll.

URI
getURI()

Gibt die URI zurück

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 Map at line 296
string __toString()

Gibt den Inhalt der Map als Zeichenkette zurück, dabei werden die Schlüssel und Werte durch das definiertes Trennzeichen : und die einzelnen Einträge der Map durch ein Komma getrennt.

Die beiden Trennzeichen können über die entsprechenden Funktionen gesetzt werden.

Return Value

string Daten des Objekts

See also

setKeyValueSeparator
setEntrySeparator

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

in Header at line 122
__construct()

Neuer Header

Der Konstruktor erstellt ein neues Header-Objekt

in Map at line 107
protected normalize(array $array)

Werte überprüfen

Diese Methode überprüft den Schlüssel und den Wert eines Arrays

Parameters

array $array zu überprüfendes Array

in Header at line 169
protected mixed normalizeValue(string $key, mixed $value)

Bearbeitung des Wertes

Überprüfung ob der Wert der Map ein bestimmter Type ist. Wenn nicht, wird eine TypeException geworfen. Diese Methode kann von abgeleiteten Klassen für die Bearbeitung der Werte verwendet werden.

Parameters

string $key Schlüssel für Zugriff
mixed $value zu überprüfender Wert

Return Value

mixed $value Rückgabewert.

in Map at line 142
Map setKeyValueSeparator(string $separator)

Setzt das Trennzeichen für die __toString Methode

Parameters

string $separator Trennzeichen

Return Value

Map dieses Objekt

in Map at line 154
Map setEntrySeparator(string $separator)

Setzt das Trennzeichen für die __toString Methode

Parameters

string $separator Trennzeichen

Return Value

Map dieses Objekt

in Map at line 164
Map clear()

Leert alle Einträge aus der Map

Return Value

Map dieses Objekt

in Map at line 177
boolean containsKey(string $key)

Prüft ob es einen Eintrag mit dem Schlüssel gibt und dieser einen Wert !== null hat.

Parameters

string $key Schlüssel

Return Value

boolean true wenn der Schlüssel vorhanden ist

in Map at line 189
boolean containsValue(mixed $value)

Prüft ob der übergebene Wert in der Map enthalten ist.

Parameters

mixed $value Wert der gesucht werden soll

Return Value

boolean true ist der Wert in der Map enthalten

in Map at line 204
Map append(Map|array $map)

Map oder Array anhängen

Hängt an die Map weitere Einträge an. Vor dem einhängen wird die Methode Map::normalize() aufgerufen.

Parameters

Map|array $map Eine anzuhängende map oder ein Key/Value Array

Return Value

Map Liefert einen Zeiger auf dieses Objekt zurück

in Map at line 226
Map setValue(string $key, mixed $value)

Wert setzen

Setzt den Wert eines Schlüssels auf den Übergebenen Wert.

Parameters

string $key Schlüssel in der Map. Wenn der Wert bereits gesetzt wurde, wird er überschrieben.
mixed $value Wert des Eintrages (muss ein einfacher Typ sein)

Return Value

Map Liefert einen Zeiger auf dieses Objekt zurück

in Map at line 240
mixed getValue(string $key, mixed $default = null)

Gibt den Wert des Schlüssels in der Map zurück.

Parameters

string $key Schlüssel
mixed $default Standardwert, wenn der Schlüssel nicht gesetzt ist.

Return Value

mixed Wert der Eigenschaft

in Map at line 253
Map remove(string $key)

Löscht den Eintrag mit dem übergebenen Schlüssel aus der Map

Parameters

string $key

Return Value

Map Dieses Objekt

in Map at line 267
Map removeValue(simple $value)

Entfernt alle Einträge, die den übergebenen Wert haben.

Der Wert muss vom identischen Typ sein, da der Vergleich mittels === erfolgt.

Parameters

simple $value

Return Value

Map Dieses Objekt

in Map at line 280
int count()

Ermittelt die Anzahl der Einträge in der Map

Return Value

int Anzahl der Einträge in der Map

in Map at line 328
static protected array prepareOutput(array $properties)

Ausgabe vorbereiten

Parameters

array $properties Schlüssel/Werte

Return Value

array Ausgabe

in Map at line 337
mixed current()

Wert des aktuellen Objektes

Return Value

mixed Gibt den Wert des aktuellen Element, oder wenn leer false zurück

in Map at line 346
mixed key()

Schlüssel des aktuellen Elements zurückgeben

Return Value

mixed Gibt den Schlüssel des aktuellen Elements, oder wenn leer false zurück

in Map at line 355
mixed next()

Den internen Zeiger der Map auf den nächsten Wert setzen.

Return Value

mixed Gibt das nächste Element, oder wenn leer false zurück

in Map at line 364
mixed rewind()

Zurücksetzen des internen Zeigers der Map auf den ersten Eintrag

Return Value

mixed Gibt das erste Element, oder wenn leer false zurück

in Map at line 374
boolean valid()

Prüft ob der interne Zeiger auf ein gültiges Element der Map zeigt.

Return Value

boolean true wenn das aktuelle Element gültig ist

in Map at line 386
Map normalizeKey(int $mode)

Wandelt die Schlüssel in Großbuchstaben oder Kleinbuchstaben um.

Parameters

int $mode Map::LOWERCASE oder Map::UPPERCASE

Return Value

Map Dieses Objekt

in Map at line 421
Map each(Closure $callback, string $filter = null)

Durchläuft alle Einträge der Map und ruft die entsprechende Funktion auf. Besonders in Zusammenhang mit den anonymen Funktionen lassen sich so sehr effiziente Konvertierungen durchführen.

$map = new Alvine\types\Map(array('aaa'=>'Auto','bbb'=>'Boot','ccc'=>'Flugzeug'));
$map->each(function($k, $v) { return $v.'...'; });
// Der Filter beachtet die groß/Kleinschreibung.
$map->each(function($k, $v) { return $v.'...'; });

Die Werte werden dann jeweils um ... ergänzt: Auto... Boot... und Flugzeug ... Über den optionalen Filter können Einschränkungen auf den Schlüssel angewendet werden.

// Mit Filter auf alle Schlüssel die mit a anfangen.
$map->each(function($k, $v) { return $v.'...'; }, 'a');

Nur das Auto würde in diesem Beispiel um ... ergänzt werden. Gibt die aufgerufene Funktion null zurück, so wird keine Zuweisung durchgeführt und der ursprüngliche Wert bleibt erhalten.

Parameters

Closure $callback Funktion die aufgerufen wird
string $filter Über einen Filter können nur ganz bestimmte Schlüsselwörter angesprochen werden.

Return Value

Map

in Map at line 437
offsetUnset(mixed $key)

Implementierung des Array-Interfaces

Parameters

mixed $key Schlüssel

in Map at line 447
offsetSet(mixed $key, mixed $value)

Implementierung des Array-Interfaces

Parameters

mixed $key Schlüssel
mixed $value Wert

in Map at line 456
offsetGet(mixed $key)

Implementierung des Array-Interfaces

Parameters

mixed $key Schlüssel

in Map at line 467
boolean offsetExists(mixed $key)

Implementierung des Array-Interfaces

Parameters

mixed $key Schlüssel

Return Value

boolean true/false

in Map at line 486
Map getIntersection(HierarchicalString|string $filter)

Teilschlüssel holen

Diese Methode holt eine Schnittmenge aus der Eigenschaftsliste mit allen Schlüsseln die zu dem Filter passen.

Diese Methode ist nicht sehr schnell und sollte mit bedacht gewählt werden.

Parameters

HierarchicalString|string $filter Filterwert

Return Value

Map Neues Objekt

in Map at line 519
Map getIntersectionGroups(HierarchicalString|string $filter, integer|null $level = null)

Teilmengen in Gruppen

Diese Methode holt eine Schnittmenge aus der Eigenschaftsliste mit allen Schlüsseln die zu dem Filter passen und gruppiert das Ergebnis zu dem gewünschten Level.

Diese Methode ist nicht sehr schnell und sollte mit bedacht gewählt werden.

Parameters

HierarchicalString|string $filter Filterwert
integer|null $level Ebenen. Wird null übergeben, wird als Ebenen die Anzahl der Teilstrings verwendet.

Return Value

Map Neues Objekt

in Map at line 565
array toArray()

Werte als Array

Die Werte werden nicht angepasst und Maps und Collection bleiben Objekte.

toArray wandelt im Gegensatz zu asArray die Unterwerte nicht um, sondern gibt nur das Array auf oberster Ebene aus.

Return Value

array Werte

in Map at line 574
string asJson()

Json-Zeichenkette

Return Value

string Json-Zeichenkette

in Map at line 587
array asArray()

Inhalt des Dataset als Array

asArray wandelt, anders als toArray die gesamte Struktur der Map so um, das es an tojson verwendet werden kann.

Return Value

array

in Map at line 598
mixed jsonSerialize()

Implementierung des JsonSerializable Interfaces. Ein Dataset gibt auf oberster Ebene immer ein Array zurück.

Return Value

mixed

in Header at line 148
Header add(string $name, string $value)

Header hinzufügen

Die Methode prüft den übergebenen Namen und prüft zusätzlich den Namen gegen die Liste static::$headerMap und passt wenn nötig die Schreibweise des Headers an. So wird aus dem Header Dnt DNT.

$obj->add('Dnt'); // DNT

Parameters

string $name Name des Headers
string $value Wert

Return Value

Header Liefert dieses Objekt zurück

in Header at line 182
Header setContentLength(string $value)

Die Anzahl an Bytes für den Requests setzen

Parameters

string $value Anzahl

Return Value

Header Dieses Objekt

in Header at line 195
Header setDate(DateTime $dateTime, $timezone = null)

Datum setzen

Setzt das Datum in der Form Tue, 15 Nov 1994 08:12:31 GMT

Parameters

DateTime $dateTime
$timezone

Return Value

Header Dieses Objekt

at line 213
protected Header setFirstLine(string $line)

Erste Zeile setzen

Parameters

string $line Linie

Return Value

Header Header

in Header at line 234
protected Header parseData(string $data)

Daten parsen

Die Daten aus dem Header werden analyisert und die entsprechenden Header-Objekte erstellt. Die Header werden dabei in einer Map gespciehrt. Einige Header können mehrfach vorkommen. Hier wird dem Namen des Headers eine forlaufende Zahl mit einem Bindestrich angestellt.

Die erste Zeile im $data muss der Rückgabewert (StatusCode) des Server sein

Set-Cookie Set-Cookie-1 Set-Cookie-2 ...

Parameters

string $data Daten

Return Value

Header Header

in Header at line 270
static Object getInstanceFromData(mixed $data)

Parst eine Zeichenkette und gibt ein Header-Objekt zurück

Parameters

mixed $data Daten

Return Value

Object Erstellte Instanz

at line 179
Header setAcceptCharset(string $value)

Setzt den akzeptierten Zeichensatz

Parameters

string $value Charset (z.B. utf-8)

Return Value

Header Dieses Objekt

at line 194
RequestHeader setCookies(ObjectMap $cookies)

Cookies setzen

Wird eine leere ObjektMap übergeben, so werden die bisherigen Cookies aus dem Header gelöscht.

Parameters

ObjectMap $cookies

Return Value

RequestHeader

at line 233
MIMEType|null getContentType()

Inhaltstyp

Ist im Header kein Inhaltstyp definiert, so gibt diese Methode null zurück.

Return Value

MIMEType|null MimeType des Requests

at line 244
setProtocol(string $protocol)

Setzt das Protokoll.

Entweder HTTP/1.0 oder HTTP/1.1 werden aktuell unterstützt.

Parameters

string $protocol Protokoll

at line 253
setMethod(string $method)

Eine der gültigen Methoden setzen

Parameters

string $method Methode

at line 262
setURI(URI $uri)

Setzen der URI

Parameters

URI $uri URI

at line 271
string getMethod()

Die Methode des Requests

Return Value

string Methode

at line 282
string getProtocol()

Holt das Protokoll.

HTTP/1.0 oder HTTP/1.1 werden aktuell unterstützt.

Return Value

string Protokoll

at line 291
URI getURI()

Gibt die URI zurück

Return Value

URI URI