Documentation

ResponseHeader extends Header
in package

Response-Header

Diese Klasse kapselt alle Header, die als Antwort auf einen Request vom Webserver gesendet wurden.

Tags
category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine
link
http://de.wikipedia.org/wiki/Liste_der_HTTP-Headerfelder
since
20110904

Table of Contents

Constants

ACCEPT_RANGES  = 'Accept-Ranges'
Welche Einheiten für Range-Angaben der Server akzeptiert
ACCESS_CONTROL_ALLOW_CREDENTIALS  = 'Access-Control-Allow-Credentials'
CORS
ACCESS_CONTROL_ALLOW_HEADERS  = 'Access-Control-Allow-Headers'
CORS
ACCESS_CONTROL_ALLOW_METHODS  = 'Access-Control-Allow-Methods'
CORS
ACCESS_CONTROL_ALLOW_ORIGIN  = 'Access-Control-Allow-Origin'
Spezifiziert welche Webbrowser "cross-origin resource sharing" unterstützen.
ACCESS_CONTROL_EXPOSE_HEADERS  = 'Access-Control-Expose-Headers'
CORS
ACCESS_CONTROL_MAX_AGE  = 'Access-Control-Max-Age'
CORS
AGE  = 'Age'
Wie lange das Objekt im Proxy-Cache gelegen hat
ALLOW  = 'Allow'
Erlaubte Aktionen für eine bestimmte Ressource.
APIVERSION  = 1
Version der API-Version der Klasse.
CACHE_CONTROL  = 'Cache-Control'
Wird genutzt, um Optionen festzulegen, denen durch alle Caching-Mechanismen entlang der Anfrage-/Antwort-Kette Folge geleistet werden muss
CONNECTION  = 'Connection'
Welchen Typ von Verbindung der Browser bevorzugt
CONTENT_DISPOSITION  = '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_ENCODING  = 'Content-Encoding'
Codierung des Inhalts
CONTENT_LANGUAGE  = 'Content-Language'
Die Sprache, in der die Datei vorliegt
CONTENT_LENGTH  = 'Content-Length'
Länge des Bodys in Bytes
CONTENT_LOCATION  = 'Content-Location'
Alternativer Name/Speicherplatz für das angeforderte Element
CONTENT_MD5  = 'Content-MD5'
Eine Base64-codierte MD5-Checksume des Bodys
CONTENT_RANGE  = 'Content-Range'
Welchen Bereich des Gesamtbodys der gesendete Inhalt abdeckt.
CONTENT_TYPE  = 'Content-Type'
MIME-Typ des Bodys
DATE  = 'Date'
Datum und Zeit zum Sendezeitpunkt
ETAG  = 'ETag'
Eine bestimmte Version einer Datei
EXPIRES  = 'Expires'
Ab wann die Datei als veraltet angesehen werden kann.
IDENTIFICATION  = 'Alvine'
Identifizierung der Alvine API
LAST_MODIFIED  = 'Last-Modified'
Zeitpunkt der letzten Änderung an der Datei
LINK  = 'Link'
Wird benutzt, um dem Browser "verwandte" Dateien oder Ressourcen mitzuteilen.
LOCATION  = 'Location'
Oft genutzt, um Clients weiterzuleiten
LOWERCASE  = 2
Kleinbuchstaben
P3P  = 'P3P'
Dieses Feld wird genutzt, um eine P3P-Datenschutz-Policy wie folgt mitzuteilen:P3P:CP="your_compact_policy".
PRAGMA  = '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
PROXY_AUTHENTICATE  = 'Proxy-Authenticate'
Anweisung, ob und wie der Browser sich beim Proxy zu authentifizieren hat.
REFRESH  = 'Refresh'
Refresh wird genutzt, um nach einer bestimmten Zahl von Sekunden weiterzuleiten oder die Seite zu aktualisieren.
RETRY_AFTER  = 'Retry-After'
Falls eine Ressource zeitweise nicht verfügbar ist, so teilt der Server dem Client mit diesem Feld mit, wann sich ein neuer Versuch lohnt.
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.
SERVER  = 'Server'
Serverkennung
SET_COOKIE  = 'Set-Cookie'
Ein Cookie
STRICT_TRANSPORT_SECURITY  = 'Strict-Transport-Security'
Die HSTS Richtlinie informiert den HTTP Client wie lange er die HTTP Richtlinien im Cache speichern soll und ob das auch Teilbereiche gilt.
TRAILER  = 'Trailer'
Das Trailer-Feld enthält die Namen der Headerfelder, die im Trailer der Antwort enthalten sind.
TRANSFER_ENCODING  = 'Trander-Encoding'
Die Methode, die genutzt wird, den Inhalt sicher zum Nutzer zu bringen.
UPPERCASE  = 1
Großbuchstaben
VARY  = 'Vary'
Zeigt Downstream-Proxys, wie sie anhand der Headerfelder zukünftige Anfragen behandeln sollen.
VERSION  = 2
Generelle Alvine-Version
VIA  = 'Via'
Gibt dem Server Informationen über Proxys im Übertragungsweg
WARNING  = 'Warning'
Allgemeine Warnungen über den Umgang mit dem Body oder den Body selbst
WWW_AUTHENTICATE  = 'WWW-Authenticate'
Definiert die Authentikationsmethode, die genutzt werden soll, um eine bestimmte Datei herunterzuladen.

Properties

$entrySeparator  : string
$hasAssociatedProperties  : boolean
$hash  : string
Eindeutige ID
$hasVolatileProperties  : boolean
$headerMap  : array
Einige Header folgen nicht dem Schema von Groß-/Kleinschreibung und müssen gesondert behandelt werden. Diese Map definiert diese Sonderfälle.
$keyValueSeparator  : string
$properties  : array
$protocol  : string
$status  : StatusCode
Status

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
Create new map
__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
add()  : Header
Header hinzufügen
append()  : Map
Map oder Array anhängen
asArray()  : array
Inhalt des Dataset als Array
asJson()  : string
Json-Zeichenkette
clear()  : Map
Leert alle Einträge aus der Map
containsKey()  : boolean
Prüft ob es einen Eintrag mit dem Schlüssel gibt und dieser einen Wert !== null hat.
containsValue()  : boolean
Prüft ob der übergebene Wert in der Map enthalten ist.
count()  : int
Ermittelt die Anzahl der Einträge in der Map
current()  : mixed
Wert des aktuellen Objektes
each()  : Map
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.
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.
getCookies()  : ObjectMap
Cookies
getHashCode()  : string
Die Methode Alvine::getID() verwenden!
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()  : Header
Parst eine Zeichenkette und gibt ein Header-Objekt zurück
getIntersection()  : Map
Teilschlüssel holen
getIntersectionGroups()  : Map
Teilmengen in Gruppen
getProtocol()  : string
Protokoll (HTTP/1.1)
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.
getStatusCode()  : StatusCode
StatusCode
getValue()  : mixed
Gibt den Wert des Schlüssels in der Map zurück.
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.
jsonSerialize()  : mixed
Implementierung des JsonSerializable Interfaces. Ein Dataset gibt auf oberster Ebene immer ein Array zurück.
key()  : mixed
Schlüssel des aktuellen Elements zurückgeben
next()  : void
Den internen Zeiger der Map auf den nächsten Wert setzen.
normalizeKey()  : Map
Wandelt die Schlüssel in Großbuchstaben oder Kleinbuchstaben um.
offsetExists()  : bool
Implementierung des Array-Interfaces
offsetGet()  : mixed
Implementierung des Array-Interfaces
offsetSet()  : void
Implementierung des Array-Interfaces
offsetUnset()  : void
Implementierung des Array-Interfaces
propertyExists()  : boolean
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
remove()  : Map
Löscht den Eintrag mit dem übergebenen Schlüssel aus der Map
removeValue()  : Map
Entfernt alle Einträge, die den übergebenen Wert haben.
rewind()  : void
Zurücksetzen des internen Zeigers der Map auf den ersten Eintrag
setContentEncoding()  : Header
Setzt das Content-Encoding
setContentLength()  : Header
Die Anzahl an Bytes für den Requests setzen
setDate()  : Header
Datum setzen
setEntrySeparator()  : Map
Setzt das Trennzeichen für die __toString Methode
setKeyValueSeparator()  : Map
Setzt das Trennzeichen für die __toString Methode
setProtocol()  : ResponseHeader
Protokoll setzen (HTTP/1.1)
setStatusCode()  : ResponseHeader
StatusCode
setValue()  : Map
Wert setzen
toArray()  : array
Werte als Array
valid()  : boolean
Prüft ob der interne Zeiger auf ein gültiges Element der Map zeigt.
checkAndAdjustSerialisation()  : array<string|int, mixed>
Dealing with versions
normalize()  : array<string|int, mixed>
Werte überprüfen
normalizeValue()  : mixed
Bearbeitung des Wertes
parseData()  : Header
Daten parsen
prepareOutput()  : array
Ausgabe vorbereiten
setFirstLine()  : ResponseHeader
Erste Zeile setzen

Constants

ACCEPT_RANGES

Welche Einheiten für Range-Angaben der Server akzeptiert

public mixed ACCEPT_RANGES = 'Accept-Ranges'

ACCESS_CONTROL_ALLOW_ORIGIN

Spezifiziert welche Webbrowser "cross-origin resource sharing" unterstützen.

public mixed ACCESS_CONTROL_ALLOW_ORIGIN = 'Access-Control-Allow-Origin'

ALLOW

Erlaubte Aktionen für eine bestimmte Ressource.

public mixed ALLOW = 'Allow'

Muss u. a. mit einem 405 Method Not Allowed gesendet werden.

APIVERSION

Version der API-Version der Klasse.

public mixed APIVERSION = 1

CACHE_CONTROL

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

public mixed CACHE_CONTROL = 'Cache-Control'

CONNECTION

Welchen Typ von Verbindung der Browser bevorzugt

public mixed CONNECTION = 'Connection'

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.

public mixed CONTENT_DISPOSITION = 'Content-Disposition'

CONTENT_ENCODING

Codierung des Inhalts

public mixed CONTENT_ENCODING = 'Content-Encoding'

CONTENT_LANGUAGE

Die Sprache, in der die Datei vorliegt

public mixed CONTENT_LANGUAGE = 'Content-Language'

CONTENT_LENGTH

Länge des Bodys in Bytes

public mixed CONTENT_LENGTH = 'Content-Length'

CONTENT_LOCATION

Alternativer Name/Speicherplatz für das angeforderte Element

public mixed CONTENT_LOCATION = 'Content-Location'

CONTENT_MD5

Eine Base64-codierte MD5-Checksume des Bodys

public mixed CONTENT_MD5 = 'Content-MD5'

CONTENT_RANGE

Welchen Bereich des Gesamtbodys der gesendete Inhalt abdeckt.

public mixed CONTENT_RANGE = 'Content-Range'

CONTENT_TYPE

MIME-Typ des Bodys

public mixed CONTENT_TYPE = 'Content-Type'

DATE

Datum und Zeit zum Sendezeitpunkt

public mixed DATE = 'Date'

EXPIRES

Ab wann die Datei als veraltet angesehen werden kann.

public mixed EXPIRES = 'Expires'

IDENTIFICATION

Identifizierung der Alvine API

public mixed IDENTIFICATION = 'Alvine'

LAST_MODIFIED

Zeitpunkt der letzten Änderung an der Datei

public mixed LAST_MODIFIED = 'Last-Modified'

LINK

Wird benutzt, um dem Browser "verwandte" Dateien oder Ressourcen mitzuteilen.

public mixed LINK = 'Link'

LOWERCASE

Kleinbuchstaben

public mixed LOWERCASE = 2

P3P

Dieses Feld wird genutzt, um eine P3P-Datenschutz-Policy wie folgt mitzuteilen:P3P:CP="your_compact_policy".

public mixed P3P = 'P3P'

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

public mixed PRAGMA = 'Pragma'

PROXY_AUTHENTICATE

Anweisung, ob und wie der Browser sich beim Proxy zu authentifizieren hat.

public mixed PROXY_AUTHENTICATE = 'Proxy-Authenticate'

REFRESH

Refresh wird genutzt, um nach einer bestimmten Zahl von Sekunden weiterzuleiten oder die Seite zu aktualisieren.

public mixed REFRESH = 'Refresh'

RETRY_AFTER

Falls eine Ressource zeitweise nicht verfügbar ist, so teilt der Server dem Client mit diesem Feld mit, wann sich ein neuer Versuch lohnt.

public mixed RETRY_AFTER = 'Retry-After'

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

STRICT_TRANSPORT_SECURITY

Die HSTS Richtlinie informiert den HTTP Client wie lange er die HTTP Richtlinien im Cache speichern soll und ob das auch Teilbereiche gilt.

public mixed STRICT_TRANSPORT_SECURITY = 'Strict-Transport-Security'

TRAILER

Das Trailer-Feld enthält die Namen der Headerfelder, die im Trailer der Antwort enthalten sind.

public mixed TRAILER = 'Trailer'

TRANSFER_ENCODING

Die Methode, die genutzt wird, den Inhalt sicher zum Nutzer zu bringen.

public mixed TRANSFER_ENCODING = 'Trander-Encoding'

UPPERCASE

Großbuchstaben

public mixed UPPERCASE = 1

VARY

Zeigt Downstream-Proxys, wie sie anhand der Headerfelder zukünftige Anfragen behandeln sollen.

public mixed VARY = 'Vary'

VERSION

Generelle Alvine-Version

public mixed VERSION = 2

VIA

Gibt dem Server Informationen über Proxys im Übertragungsweg

public mixed VIA = 'Via'

WARNING

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

public mixed WARNING = 'Warning'

WWW_AUTHENTICATE

Definiert die Authentikationsmethode, die genutzt werden soll, um eine bestimmte Datei herunterzuladen.

public mixed WWW_AUTHENTICATE = 'WWW-Authenticate'

Properties

$entrySeparator

protected string $entrySeparator = ','

Trennzeichen der Key/Value Einträge

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

$headerMap

Einige Header folgen nicht dem Schema von Groß-/Kleinschreibung und müssen gesondert behandelt werden. Diese Map definiert diese Sonderfälle.

protected static array $headerMap = ['x-rewrite-url' => 'X-Rewrite-URL', 'x-http-method-override' => 'X-HTTP-Method-Override', 'x-http-method' => 'X-HTTP-Method', 'dnt' => 'DNT']

Liste mit definierten Array

$keyValueSeparator

protected string $keyValueSeparator = ':'

Trennzeichen zwischen den Key/Value Einträge

$properties

protected array $properties = []

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

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
throws
NotCallableException

Exception

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

Create new map

public __construct([Map|array $map = null ]) : mixed

Creates a new map and assigns the passed key/value pairs * to the map. to the map. If the value of the array is not a simple * value, a TypeException is thrown. value, a TypeException is thrown.

Parameters
$map : Map|array = null

Eine anzuhängende map oder ein Key/Value Array

__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
throws
BadPropertyException
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
see
https://php.watch/versions/8.1/serializable-deprecated
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

__unset()

Zurücksetzen von Werten

public __unset(string $name) : mixed
Parameters
$name : string

add()

Header hinzufügen

public add(string $name, string $value) : Header

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
$name : string

Name des Headers

$value : string

Wert

Return values
Header —

Liefert dieses Objekt zurück

append()

Map oder Array anhängen

public append(Map|array $map) : Map

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

Parameters
$map : Map|array

Eine anzuhängende map oder ein Key/Value Array

Return values
Map —

Liefert einen Zeiger auf dieses Objekt zurück

asArray()

Inhalt des Dataset als Array

public asArray() : array

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

Return values
array

asJson()

Json-Zeichenkette

public asJson() : string
Return values
string —

Json-Zeichenkette

clear()

Leert alle Einträge aus der Map

public clear() : Map
Return values
Map —

dieses Objekt

containsKey()

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

public containsKey(string $key) : boolean
Parameters
$key : string

Schlüssel

Return values
boolean —

true wenn der Schlüssel vorhanden ist

containsValue()

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

public containsValue(mixed $value) : boolean
Parameters
$value : mixed

Wert der gesucht werden soll

Return values
boolean —

true ist der Wert in der Map enthalten

count()

Ermittelt die Anzahl der Einträge in der Map

public count() : int
Return values
int —

Anzahl der Einträge in der Map

current()

Wert des aktuellen Objektes

public current() : mixed
Return values
mixed —

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

each()

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.

public each(Closure $callback[, string $filter = null ]) : Map 
$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
$callback : Closure

Funktion die aufgerufen wird

$filter : string = null

Über einen Filter können nur ganz bestimmte Schlüsselwörter angesprochen werden.

Return values
Map

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
see
ClassType::getNormalizedName
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
see
Alvine::__clone()
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

Tags
throws
NotFoundException
throws
BadPropertyException
Return values
Closure

getHashCode()

Die Methode Alvine::getID() verwenden!

public getHashCode() : string
Tags
deprecated
20140611
Return values
string —

Hashwert des Objektes

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

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

public static getInstanceFromData(string $data) : Header
Parameters
$data : string

Zeichekette

Return values
Header —

Header

getIntersection()

Teilschlüssel holen

public getIntersection(HierarchicalString|string $filter) : Map

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
$filter : HierarchicalString|string

Filterwert

Return values
Map —

Neues Objekt

getIntersectionGroups()

Teilmengen in Gruppen

public getIntersectionGroups(HierarchicalString|string $filter[, integer|null $level = null ]) : Map

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
$filter : HierarchicalString|string

Filterwert

$level : integer|null = null

Ebenen. Wird null übergeben, wird als Ebenen die Anzahl der Teilstrings verwendet.

Return values
Map —

Neues Objekt

getProtocol()

Protokoll (HTTP/1.1)

public getProtocol() : string
Return values
string —

Protokoll

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

getValue()

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

public getValue(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string

Schlüssel

$default : mixed = null

Standardwert, wenn der Schlüssel nicht gesetzt ist.

Return values
mixed —

Wert der Eigenschaft

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

jsonSerialize()

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

public jsonSerialize() : mixed
Return values
mixed

key()

Schlüssel des aktuellen Elements zurückgeben

public key() : mixed
Return values
mixed —

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

next()

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

public next() : void
Return values
void

normalizeKey()

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

public normalizeKey(int $mode) : Map
Parameters
$mode : int

Map::LOWERCASE oder Map::UPPERCASE

Return values
Map —

Dieses Objekt

offsetExists()

Implementierung des Array-Interfaces

public offsetExists(mixed $key) : bool
Parameters
$key : mixed

Schlüssel

Return values
bool —

true/false

offsetGet()

Implementierung des Array-Interfaces

public offsetGet(mixed $key) : mixed
Parameters
$key : mixed

Schlüssel

offsetSet()

Implementierung des Array-Interfaces

public offsetSet(mixed $key, mixed $value) : void
Parameters
$key : mixed

Schlüssel

$value : mixed

Wert

offsetUnset()

Implementierung des Array-Interfaces

public offsetUnset(mixed $key) : void
Parameters
$key : mixed

Schlüssel

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

remove()

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

public remove(string $key) : Map
Parameters
$key : string
Return values
Map —

Dieses Objekt

removeValue()

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

public removeValue(simple $value) : Map

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

Parameters
$value : simple
Return values
Map —

Dieses Objekt

rewind()

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

public rewind() : void

setContentEncoding()

Setzt das Content-Encoding

public setContentEncoding(string $value) : Header
Parameters
$value : string

Encoding

Return values
Header —

Dieses Objekt

setContentLength()

Die Anzahl an Bytes für den Requests setzen

public setContentLength(string $value) : Header
Parameters
$value : string

Anzahl

Return values
Header —

Dieses Objekt

setDate()

Datum setzen

public setDate(DateTime $dateTime[, mixed $timezone = null ]) : Header

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

Parameters
$dateTime : DateTime

Datum

$timezone : mixed = null
Return values
Header —

Dieses Objekt

setEntrySeparator()

Setzt das Trennzeichen für die __toString Methode

public setEntrySeparator(string $separator) : Map
Parameters
$separator : string

Trennzeichen

Return values
Map —

dieses Objekt

setKeyValueSeparator()

Setzt das Trennzeichen für die __toString Methode

public setKeyValueSeparator(string $separator) : Map
Parameters
$separator : string

Trennzeichen

Return values
Map —

dieses Objekt

setValue()

Wert setzen

public setValue(string $key, mixed $value) : Map

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

Parameters
$key : string

Schlüssel in der Map. Wenn der Wert bereits gesetzt wurde, wird er überschrieben.

$value : mixed

Wert des Eintrages (muss ein einfacher Typ sein)

Return values
Map —

Liefert einen Zeiger auf dieses Objekt zurück

toArray()

Werte als Array

public toArray() : 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 values
array —

Werte

valid()

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

public valid() : boolean
Return values
boolean —

true wenn das aktuelle Element gültig ist

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

Tags
throws
UnserializeException

Keine Übereinstimmung

Return values
array<string|int, mixed>

normalize()

Werte überprüfen

protected normalize(array $array) : array<string|int, mixed>

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

Parameters
$array : array

zu überprüfendes Array

Return values
array<string|int, mixed>

normalizeValue()

Bearbeitung des Wertes

protected normalizeValue(string $key, mixed $value) : mixed

Ü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
$key : string

Schlüssel für Zugriff

$value : mixed

zu überprüfender Wert

Return values
mixed —

$value Rückgabewert.

parseData()

Daten parsen

protected parseData(string $data) : Header

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
$data : string

Daten

Return values
Header —

Header

prepareOutput()

Ausgabe vorbereiten

protected static prepareOutput(array $properties) : array
Parameters
$properties : array

Schlüssel/Werte

Return values
array —

Ausgabe


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results