Zend Framework 1.7.9 Manual

Zend_Http_Client basiert auf einem Design mit Verbindungsadaptern. Der Verbindungsadapter ist das Objekt, welches für die Ausführung der aktuellen Verbindung zum Server sowie für das Schreiben der Anfragen und Lesen von Antworten verantwortlich ist. Dieser Verbindungsadapter kann ersetzt werden und man kann den Standard Verbindungsadapter durch seinen eigenen Adapter erweitern, um ihn mit dem selben Interface auf seine eigenen Bedürfnisse anzupassen, ohne dass man die gesamte HTTP Client Klasse erweitern oder ersetzen muss.

Derzeit stellt die Zend_Http_Client Klasse zwei eingebaute Verbindungsadapter bereit:

• Zend_Http_Client_Adapter_Socket (Standard)

• Zend_Http_Client_Adapter_Proxy

• Zend_Http_Client_Adapter_Test

Der Verbindungsadapter für das Zend_Http_Client Objekt wird durch Verwendung der 'adapter' Konfigurationsoption gesetzt. Beim Instanzieren des Client Objektes kann man die 'adapter' Konfigurationsoption setzen mit einem String, der den Adapternamen (z.B. 'Zend_Http_Client_Adapter_Socket') enthält, oder mit eine Variable, die ein Adapterobjekt (z.B. new Zend_Http_Client_Adapter_Test) enthält. Man kann den Adapter auch danach setzen, indem man die Zend_Http_Client->setConfig() Methode verwendet.

Der Standard-Adapter von Zend_Http_Client ist der Zend_Http_Client_Adapter_Socket. Dieser wird benutzt, wenn kein anderer angegeben wird. Der Socket Adapter benutzt die native PHP Funktion fsockopen(), um die Verbindung aufzubauen, dafür werden keine besonderen PHP-Extensions oder Einstellungen benötigt.

Der Socket Adapter erlaubt verschiedene zusätzliche Konfigurations Optionen die gesetzt werden können durch Verwendung von Zend_Http_Client->setConfig() oder deren Übergabe an den Konstruktor des Clients.

Note: Persistente TCP Verbindungen

Die Verwendung persistenter TCP Verbindungen kann HTTP Anfragen potentiell schneller machen - aber in den meisten Fällen, wird es nur einen kleinen positiven Effekt haben und könnte den HTTP Server überladen zu dem man sich verbindet.

Es wird empfohlen persistente TCP Verbindungen nur dann zu verwenden wenn man sich zu dem gleichen Server sehr oft verbindet, und man sicher ist das der Server eine große Anzahl an gleichzeitigen Verbindungen behandeln kann. In jedem Fall wird empfohlen das der Effekt von persistenten Verbindungen auf beiden, der Geschwindigkeit des Clients und dem Serverload gemessen wird bevor diese Option verwendet wird.

Zusätzlich, wenn persistente Verbindungen verwendet werden, sollte man Keep-Alive HTTP Anfragen aktivieren wie in Konfigurationsparameter beschrieben - andernfalls werden persistente Verbindungen nur wenig oder gar keinen Effekt haben.

Note: HTTPS SSL Stream Parameter

ssltransport, sslcert und sslpassphrase sind nur relevant wenn HTTPS für die Verbindung verwendet wird.

Wärend die Standard SSL Einstellungen für die meisten Anwendungen funktionieren, kann es notwendig sein diese zu Ändern wenn der Server zu dem man sich verbindet ein spezielles Client Setup benötigt. Wenn dem so ist, sollte man das Kapitel über SSL Transport Layer und Optionen lesen das » hier zu finden ist.

// Konfigurationsparameter setzen
$config = array(
    'adapter'      => 'Zend_Http_Client_Adapter_Socket',
    'ssltransport' => 'tls'
);

// Client-Instanz erzeugen
$client = new Zend_Http_Client('https://www.example.com', $config);

// Jetzt wird der Request über eine verschlüsselte Verbindung verschickt
$response = $client->request();

Ein ähnliches Ergebnis erzielt man mit folgendem Code:

fsockopen('tls://www.example.com', 443)

Der Proxy Adapter Zend_Http_Client_Adapter_Proxy verhält sich wie der standard Zend_Http_Client_Adapter_Socket, mit dem Unterschied, dass die Verbindung über einen Proxy-Server aufgebaut wird.

Der Proxy Adapter benötigt zusätzliche Konfigurationsvariablen, die nachfolgend gelistet sind.

proxy_host muss immer gesetzt werden, ansonsten wird der Proxy-Adapter auf Zend_Http_Client_Adapter_Socket zurückgreifen und keinen Proxy Server benutzen. Wird kein Prot mit übergeben, so versucht der Proxy-Adapter sich auf den Standardport '8080' zu verbinden.

proxy_user und proxy_pass werden nur dann benötigt, wenn der Proxy-Server tatsächlich eine Authentifizierung erwartet. Werden diese Parameter mit übergeben, setzt der Proxy-Adapter zusätzlich den 'Proxy-Authentication' Header bei Anfragen. Wird keine Authentifizierung benötigt, sollten die beiden Parameter weggelassen werden.

proxy_auth setzt den Authentifizierungs-Typ. Dies ist nur nötig, wenn der Proxy-Server eine Authentifizierung erwartet. Mögliche Werte entsprechen denen der Zend_Http_Client::setAuth() Methode. Zur Zeit wird nur die BASIC-Authentifizierung ((Zend_Http_Client::AUTH_BASIC) unterstützt.

// Konfigurationsparameter setzen
$config = array(
    'adapter'    => 'Zend_Http_Client_Adapter_Proxy',
    'proxy_host' => 'proxy.int.zend.com',
     'proxy_port' => 8000,
    'proxy_user' => 'shahar.e',
    'proxy_pass' => 'bananashaped'
);

// Client-Objekt instanziieren
$client = new Zend_Http_Client('http://www.example.com', $config);

// $client kann jetzt wie gewohnt benutzt werden

Wie vorher erwähnt, nutzt der Proxy-Adapter eine einfache Socket-Verbindung, wenn proxy_host nicht gesetzt oder leer gelassen wurde. Dies ermöglicht die optionale Nutzung eines Proxy-Servers, abhängig von dem proxy_host Parameter.

Manchmal ist es sehr schwer Code tu testen, der von HTTP Verbindungen abhängig ist. Zum Beispiel verlangt das Testen einer Applikation, die einen RSS Feed von einem fremden Server anfordert, eine Netzwerkverbindung, die nicht immer verfügbar ist.

Aus diesem Grund wird der Zend_Http_Client_Adapter_Test Adapter bereit gestellt. Man kann seine eigenen Applikationen schreiben, um Zend_Http_Client zu verwenden, und nur zu Testzwecken, z.B. in der Unit Test Suite, den Standardadapter durch den Testadapter (ein Mock Objekt) austauschen, um Tests ohne direkte Serverbindungen auszuführen.

Der Zend_Http_Client_Adapter_Test Adapter stellt die zusätzliche Methode setResponse() bereit. Diese Methode nimmt einen Parameter entgegen, der eine HTTP Antwort entweder als Text oder als Zend_Http_Response Objekt repräsentiert. Einmal eingerichtet, wird der Testadapter immer diese Antwort zurückgeben, ohne tatsächlich eine HTTP Anfrage auszuführen.

// Instanziere einen neuen Adapter und Client
$adapter = new Zend_Http_Client_Adapter_Test();
$client = new Zend_Http_Client('http://www.example.com', array(
    'adapter' => $adapter
));

// Setze die erwartete Antwort
$adapter->setResponse(
    "HTTP/1.1 200 OK"        . "\r\n" .
    "Content-type: text/xml" . "\r\n" .
                               "\r\n" .
    '' .
    '' .
    '  ' .
    '    ' .
    // und so weiter...
    '');

$response = $client->request('GET');
// .. setze die Verarbeitung von $response fort...

Das obere Beispiel zeigt, wie man einen HTTP Client voreinstellen kann, damit er die benötigte Antwort zurückgibt. Danach kann man mit den Testen des eigenen Codes weiter machen, ohne von einer Netzwerkverbindung, der Serverantwort, etc. abhängig zu sein. In diesem Fall würde der Test mit der Prüfung fortfahren, wie die Applikation das XML aus der Antwort verarbeitet..

Manchmal erfordert ein einziger Methoden-Aufruf mehrere HTTP-Übertragungen. Um mehrere HTTP-Antworten zu erstellen, müssen mit setResponse() die erste und mit addResponse() die nachfolgenden Antworten gesetzt werden.

// Instanzen vom Adapter und Client erzeugen
$adapter = new Zend_Http_Client_Adapter_Test();
$client = new Zend_Http_Client('http://www.example.com', array(
    'adapter' => $adapter
));

// mit setResponse() die erste Antwort setzen
$adapter->setResponse(
    "HTTP/1.1 302 Found"      . "\r\n" .
    "Location: /"             . "\r\n" .
    "Content-Type: text/html" . "\r\n" .
                                "\r\n" .
    '' .
    '  ' .
    '  
This page has moved.
' .
    '');

// mit addResponse() nachfolgende Antworten setzen
$adapter->addResponse(
    "HTTP/1.1 200 OK"         . "\r\n" .
    "Content-Type: text/html" . "\r\n" .
                                    "\r\n" .
    '' .
    '  ' .
    '  
...
' .
    '');

// Das $client Objekt kann jetzt zu testzwecken herangezogen werden,
// indem es wie ein normales Client-Objekt benutzt wird.

Die HTTP-Antworten werden in der Reihenfolge zurückgegeben, in der sie angelegt worden sind. Gibt es mehr Anfragen als Antworten, so wird wieder bei der ersten Antwort angefangen.

Das oben angeführte Beispiel kann dazu benutzt werden, um die Reaktion der eigenen Anwendung auf einen 302 Redirect (Weiterleitung) zu testen. Abhängig von Ihrer Anwendung, kann es gewollt oder nicht gewollt sein, dass dem Redirect gefolgt wird.

Es ist möglich eigene Verbindungs-Adapter zu schreiben, die spezielle Bedürfnisse, wie persistente Sockets oder gecachte Verbindungen, abdecken. Diese können dann, wie gewohnt mit dem Zend_Http_Client benutzt werden.

Um einen neuen Adapter zu erstellen, muss eine neue Klasse angelegt werden, die das Zend_Http_Client_Adapter_Interface implementiert. Nachfolgend finden Sie ein Gerüst für einen neuen Adapter. Die public-Methoden müssen unbedingt implementiert werden.

class MyApp_Http_Client_Adapter_BananaProtocol
    implements Zend_Http_Client_Adapter_Interface
{
    /**
     * Konfigurationsarray für den Adapter
     *
     * @param array $config
     */
    public function setConfig($config = array())
    {
        // in den meisten Fällen kann die Implementierung von
        // Zend_Http_Client_Adapter_Socket eins zu eins übernommen werden
    }

    /**
     * Zum Server verbinden
     *
     * @param string  $host
     * @param int     $port
     * @param boolean $secure
     */
    public function connect($host, $port = 80, $secure = false)
    {
        // Verbindung zum Server herstellen
    }

    /**
     * Anfrage / Request an den Server stellen
     *
     * @param string        $method
     * @param Zend_Uri_Http $url
     * @param string        $http_ver
     * @param array         $headers
     * @param string        $body
     * @return string Request as text
     */
    public function write($method,
                          $url,
                          $http_ver = '1.1',
                          $headers = array(),
                          $body = '')
    {
        // Anfrage stellen
        // Diese Methode muss die komplette Antwort zurückliefern,
        // inklusive aller Header
    }

    /**
     * Antwort des Servers auslesen
     *
     * @return string
     */
    public function read()
    {
        // Antwort des Servers lesen und als String zurückgeben
    }

    /**
     * Verbindung zum Server beenden
     *
     */
    public function close()
    {
        // Verbindung beenden - wird zum Schluss aufgerufen
    }
}

// Jetzt kann der Adapter benutzt werden:
$client = new Zend_Http_Client(array(
    'adapter' => 'MyApp_Http_Client_Adapter_BananaProtocol'
));