AccessControlAllowOriginField
class AccessControlAllowOriginField extends Field
AccessControlAllowOriginField
Access-Control-Allow-Origin: *
Traits
Constants
VERSION |
Generelle Alvine-Version |
APIVERSION |
Version der API-Version der Klasse. |
IDENTIFICATION |
Identifizierung der Alvine API |
SERIALVERSION |
Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren. |
FIELD_NAME |
Name des Feldes |
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 | $key | from KeyValue | |
protected mixed | $value | from KeyValue | |
protected string | $keyValueSeparator | from KeyValue |
Methods
Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.
Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der
Wert, der von Alvine::getID()
zurückgeliefert wird ermittelt und das
Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.
Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.
Setzt das Trennzeichen für die __toString Methode
Neue Instanz aus einer Zeichenkette
Details
in SerializableImplementation at line 122
string
serialize()
Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.
Soll eine abgeleitete Klasse nicht serialisierbar sein, so muss diese Methode überschrieben werden und eine Exception werfen.
Eigenschaften die mit volatile oder associated beginnen werden gesonder behandelt. Eigenschaften mit Prefix volatile werde nicht serialisiert. Bei Eigenschaften mit der Vorsilbe associated wird nur die ID des Objektes serialisiert. Wird in der Eigenschaft kein Objekt gespeichert wird eine TypeException geworfen.
in SerializableImplementation at line 193
bool
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 205
bool
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 228
protected
checkAndAdjustSerialisation(array $serialization)
Umgang mit Versionen
Diese Methode überprüft ein Objekt und repariert im idealfall ältere Kopien. Kann eine alte Kopie nicht wieder hergestellt werden, so wird eine Exeption geworfen.
Diese Methode muss von den abgeleiteten Klassen überschrieben werden. In der abgeleiteten Klasse sollte die Parent-Methode aufgerufen werden.
in SerializableImplementation at line 252
void
unserialize(string $serialized)
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
in Field at line 142
string
__toString()
Header-Field
Gibt anders als die Klasse KeyValue nur den Wert des Objektes aus, damit man leichter auf den Feldinhalt zugreifen kann.
in KeyValue at line 144
void
__set(string $name, mixed $value)
Wert setzen
in Alvine at line 222
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 231
__unset(string $name)
Zurücksetzen von Werten
in KeyValue at line 132
mixed
__get(string $name)
Standardverhalten von $kv->xyz;
in Alvine at line 281
Closure
getClosure(string $name)
Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.
in Alvine at line 307
boolean
propertyExists(string $name)
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
if($obj->propertyExists('myproperty')) {
$value = $obj->myproperty;
}
in Alvine at line 339
mixed
__call(string $name, array $arguments)
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Achtung: Wird das Closure in einem Objekt definiert, so ist die Variable $this nicht das Objekt des Closures, sondern des, in dem das Closure definiert wurde.
// als erster Parameter wird immer das Objekt übergeben
$a->myfunction = function($obj, $b) { echo $b.'!'; };
// Aufruf als Eigenschaft ohne Parameter
$a->myfunction; // Ausgabe ist ein !
//
// Aufruf als Methode mit Parametern
$a->myfunction('OK'); // Ausgabe ist OK!
in Alvine at line 362
boolean
isCallable(type $name)
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
if($obj->isCallable('myfunction')) {
$obj->myfunction();
}
in Alvine at line 376
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
in Alvine at line 396
string
getID()
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
Objekte haben bei der Erstellung noch keine eindeutige ID, erst mit dem expliziten Aufruf der ID wird diese einmalig erstellt und im Objekt gepseichert.
Diese Methode wird implizit beim Serialisieren aufgerufen.
Die UUID ist dabei vom Type4 (Random)
in Alvine at line 416
string
getShortID(int|null $length = null)
Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.
Diese Methode ist hilfreich um Platz zu sparen.
Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision mit anderen Hash vergleichbarer Objekte.
in Alvine at line 442
boolean
equals(Alvine $object)
Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der
Wert, der von Alvine::getID()
zurückgeliefert wird ermittelt und das
Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
class MyObject extends Alvine {};
$objA = new MyObject();
$objB = new MyObject();
if($objA->equals($objB)) {
// ...
}
in Alvine at line 463
Alvine
getClone(boolean $deepClone = false)
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
Wenn eine abgeleitete Klasse diese Methode nicht unterstützt, so muss diese die Methode überschreiben und eine CloneNotSupportedException werfen. Die Standardmethode klont eine seichte Kopie der Eigenschaften. Das bedeutet das Objekte in den Eigenschaften nicht geclont werden. Sollen diese auch geclont werden muss true übergeben werden.
Wenn weitere Funktionen implementiert werden sollen, so muss __clone überschrieben werden
in Alvine at line 475
__clone()
Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.
Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.
in Alvine at line 493
string
getClass()
Name der Klasse
class MyObject extends Alvine {};
$obj = new MyObject();
echo $obj->getClass();
in Alvine at line 518
boolean
isInstanceOf(object $object)
Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.
if($obj instanceof Alvine &&
$obj->isInstanceOf($object)) { };
Die Prüfung entspricht
$this instanceof $object
in Field at line 56
__construct(mixed $value = null)
Neues Objekt
Der Konstruktor erstellt ein neues Objekt mit einem Wert, der Schlüssel wird über die abgeleiteten Klassen oder über die Methode setKey gesetzt.
in KeyValue at line 81
KeyValue
setKeyValueSeparator(string $separator)
Setzt das Trennzeichen für die __toString Methode
in KeyValue at line 91
string
getKey()
Gibt den Schlüssel zurück
in KeyValue at line 100
mixed
getValue()
Wert zurückgeben
in KeyValue at line 119
mixed
setValue($value)
Wert zurückgeben
in Field at line 73
protected KeyValue
normalizeValue()
Wert parsen
Diese Methode kann von abgeleiteten Klasse überschrieben werden. Beim erstellen eines neuen Objektes sorgt diese Methode dafür, das die zugehörigen Werte gesetzt werden.
in KeyValue at line 208
KeyValue
parse(type $string)
deprecated
deprecated
KeyValue Zeichenkette zerlegen
KeyValue über eine Zeichenkette setzen. Es wird kein neues Objekt erstelt, sondern der Schlüssel und der Wert über den String gesetzt.
in KeyValue at line 243
static KeyValue
getInstanceFromString(string $string, string|null $separator = null)
Neue Instanz aus einer Zeichenkette
in Field at line 97
static static|fieldClass
createFieldFromString(string $string)
Feld erstellen
Diese Methode erstellt ein Feld-Objekt, das dem gegebenen Namen entspricht. So wird bei dem Header Content-Type: text/html; charset=ISO-8859-4 ein \Alvine\Net\Http\Header\ContentTypeField Objekt zurückgegeben. Wird kein spezifisches Objekt gefunden, so wird ein \Alvine\Net\Http\Header\Field Objekt erstellt.
in Field at line 115
string
getName()
Alias für getKey
in Field at line 128
string
getRFC2616String()
Header-Field
Ausgabe des Header-Fields in der genormten Schreibweise.