HTTPClient

Serialisieren

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.

Prüfen ob das Objekt associative Eigenschaften besitzt

Prüfen ob das Objekt volatile Eigenschaften besitzt

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.

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

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;

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

Zurücksetzen von Werten

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;
}

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.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

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!

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

Die Methode Alvine::getID() verwenden!

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)

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.

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)) {
  // ...
}

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

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.

Name der Klasse

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

echo $obj->getClass();

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

Neuen HTTP-Client erstellen

Netzwerkverbindung schliessen

Netzwerkverbindung öffnen. Ist bereits eine Verbindung aktiv, so wird diese Verbindung geschlossen und eine neue Verbindung geöffnet.

Gibt den aktuellen Status des Objekts zurück

Fügt einen Beobachter zum Status-Objekt hinzu

Diese Methode entfernt einen Beobachter von der Liste der Status-Beobchter.

Setzen des Context der Verbindung

Kontext Objekt

Netzwerkverbindung beenden

Beendet eine Netzwerkverbindung. Wichtiger Hinweis: Die Funktion schreibt den Verlauf der Kommunikation mit dem Level Trace in den networking-Logger. Dabei ist zu beachten, das eine Weiterleitung der Nachrichten nicht mit Logger-Handlern die dies Klasse verwenden (z.B. MailHandler) funktionieren. Optimalerweise wird ein Dateihandler verwendet.

Gibt die Logdaten, falls Socket::enableLog() aufgerufen wurde, zurück.

Prüfen auf Ende der Übertragung

Prüft, ob die Empfangenen Daten ausreichen und gibt false oder true zurück. Wird true zurückgegeben beendet der Socket das Empfangen der Daten.

Empfang der Daten

$client = new Alvine\Net\Client('mailserver', 25);
$client->connect();
echo $client->receive();
$client->send("QUIT\r\n");

Ermöglicht das überarbeiten der empfangenen Daten, insbesondere bei Clients die ein Long-Polling verwenden.

Wichtig: Diese Funktion wird innerhalb der receive-Queue und vor Socket::isReceivedFinished() aufgerufen. Wird Socket::receiveBuffer bearbeitet, so muss unter Umständen Socket::isReceivedFinished() darauf abgestimmt werden.

Logging deaktivieren

Logging aktivieren

Empfangsbuffer leeren

Gekapselter Funktionsaufruf für socket_get_status

Diese Methode kann in den Unit-Tests für das mocking überschrieben werden.

Gekapselter Funktionsaufruf für stream_get_contents

Diese Methode kann in den Unit-Tests für das mocking überschrieben werden.

Senden

Daten über die Netzwerkverbindung senden.

Diese Funktion kann von abgeleiteten Klassen überschrieben werden, um zu entscheiden ob man im Falle eines fwrite-Errors abbricht, fortfährt oder eine Exception wirft.

Im Falle von HTTP kann zum Beispiel der Server die Verbinfung abbrechen und die Fehlermldung 413 to large schicken. Diese sollte dann aber eingelesen werden.

In dieser Klasse wird der auftretende Fehler nicht betrachtet und es wird versucht fortzufahren. Ggf muss man in einer abgeleiteten Klasse noch auf die Exception prüfen.

Status

Ist der Socket verbunden?

Modus des Sockets

Setzt den Verbindungsmodus entweder auf Socket::NONBLOCKING (nicht blockierend) oder auf Socket::BLOCKING (blockierend)

Protokoll

Host

Port

Path

Timeout

Erstellen einer Sockeresourche über eine URI

// Web-Client
new Client('tcp://www.example.com:80/path/to/my/api');

// Unix-Client
new Client('unix:///full/path/to/my/socket.sock');

Ist für diese Klasse ohne Funktion

Absolute URI senden

Im Standard wird im Request eine absolute URI in der Requestzeile gesendet. Dies ist insbesondere für Anfragen die über einen Proxy erfolgen notwendig.

URL setzen

Protokoll

Protokoll aus der URL ermitteln

Port

Port aus der URL oder den Standards ermitteln.

URI überprüfen

Macht aus einer Zeichenkette ein Objekt und gibt dieses zurück. Wird eine relative URI übergeben, so wird zusammen mit der in der Klasse definierten URI eine absulote URI erstellt.

setCredential

Über diese Methoden kann die Authentifizierung des Requests gesetzt werden.

Datenübertragung

Request in Daten umwandeln und senden.

protected function convertAndSendRequest(Request $request) {
  // Request bearbeiten
  parent::convertAndSendRequest($request);
}

Ein Request senden

Ein aus einem Header und Body zusammengesetzten Request senden. Wird als URI ein relativer Pfand angegeben, so wird dieser in Bezug zur Basis URI verwendet.

$httpClient = new \Alvine\Net\Http\HTTPClient(new \Alvine\Net\Resource\URI('http://www.exampe.com/'));
$formdata = new FormData();
$formdata->setValue('key', 'value');
// Relative URI
$response = $httpClient->post('/post.php', $formdata);
// Absolute URI
$response = $httpClient->post('http://www.exampe.com/post.php', $formdata);

Die Aufrufe über HTTPClient::sendRequest() können über den HTTP-Logger mit Level::TRACE nachverfolgt werden. Sie Codebeispiel im Klassenkopf.

URI für den Request und bei Proxies die URI des Proxies

Diese Methode schneidet einen möglichen HTTP/1.1 100 Continue Header aus dem Datenstrom.

GET-Abfrage durchführen

POST-Request durchführen

Die POST-Methode wurde für die Übertragung von Formulardaten entwickelt. Sie dient dazu Fomulardaten vom Client an den Server zu übermitteln.

PATCH-Request durchführen

Die PATCH-Methode wurde für die Übertragung von Formulardaten entwickelt. Sie dient dazu partiellen Daten vom Client an den Server zu übermitteln.

PUT-Abfrage durchführen

Die PUT-Methode ähnelt der POST-Methode. Sie ermöglicht es eine neue Resource auf dem Server anzulegen. Im Gegensatz zur POST-Methode ist der Server nicht angewiesen die übertragene Datei an ein Script zu übergeben, sondern vielmehr die Resource an der benannten Stelle zu plazieren.

Über ein URL-Routing können so aber auch Datensätze in einer Datenbank angelegt werden.

GET-Abfrage durchführen

DELETE-Abfrage durchführen

Die DELETE-Methode ist das Gegenstück zur PUT-Methode. Sie veranlasst, dass die übertragenen Ressource, die unter der angegebenen Adresse zu finden ist, vom Server gelöscht wird.

TRACE-Abfrage durchführen

OPTION-Abfrage durchführen