Глава 15. Zend_Http

Содержание

15.1. Zend_Http_Client - Введение
15.1.1. Введение
15.1.2. Параметры конфигурации
15.1.3. Выполнение базовых HTTP-запросов
15.1.4. Добавление параметров GET и POST
15.1.5. Получение последних запроса и ответа
15.2. Zend_Http_Client - Advanced Usage
15.2.1. HTTP Redirections
15.2.2. Adding Cookies and Using Cookie Persistence
15.2.3. Setting Custom Request Headers
15.2.4. File Uploads
15.2.5. Sending Raw POST Data
15.2.6. HTTP Authentication
15.2.7. Sending Multiple Requests With the Same Client
15.3. Zend_Http_Client - Connection Adapters
15.3.1. Overview
15.3.2. The Socket Adapter
15.3.3. The Proxy Adapter
15.3.4. The Test Adapter
15.3.5. Creating your own connection adapters
15.4. Zend_Http_Cookie and Zend_Http_CookieJar
15.4.1. Introduction
15.4.2. Instantiating Zend_Http_Cookie Objects
15.4.3. Zend_Http_Cookie getter methods
15.4.4. Zend_Http_Cookie: Matching against a scenario
15.4.5. The Zend_Http_CookieJar Class: Instantiation
15.4.6. Adding Cookies to a Zend_Http_CookieJar object
15.4.7. Retrieving Cookies From a Zend_Http_CookieJar object
15.5. Zend_Http_Response
15.5.1. Introduction
15.5.2. Boolean Tester Methods
15.5.3. Accessor Methods
15.5.4. Static HTTP Response Parsers

15.1. Zend_Http_Client - Введение

15.1.1. Введение

Zend_Http_Client предоставляет простой интерфейс для выполнения HTTP-запросов. Zend_Http_Client поддерживает как большинство простых возможностей, ожидаемых от любого HTTP-клиента, так и более сложные функции, такие, как HTTP-аутентификация и выгрузка файлов. При успешно выполненных запросах (и большинстве неуспешно выполненных) возвращается объект Zend_Http_Response, который предоставляет доступ к заголовкам и телу ответа (см. Раздел 15.5, «Zend_Http_Response»).

Конструктор класса опционально принимает URL (может быть строкой или объектом Zend_Uri_Http) и массив конфирурационных параметров. Оба параметра могут быть опущены и установлены позднее через методы setUri() и setConfig().

Пример 15.1. Инстанцирование объекта Zend_Http_Client

<?php
    require_once 'Zend/Http/Client.php';

    $client = new Zend_Http_Client('http://example.org', array(
        'maxredirects' => 0,
        'timeout'      => 30));
        
    // Этот код делает то же самое:
    $client = new Zend_Http_Client();
    $client->setUri('http://example.org');
    $client->setConfig(array(
        'maxredirects' => 0,
        'timeout'      => 30));

?>

15.1.2. Параметры конфигурации

Конструктор и метод setConfig() принимают ассоциативный массив параметров конфигурации. Установка этих параметров является опциональной, поскольку все они имеют значения по умолчанию.

Таблица 15.1. Параметры конфигурации Zend_Http_Client

Параметр Описание Тип Значение по умолчанию
maxredirects Максимальное количество последующих перенаправлений (0 = ни одного перенаправления) integer 5
strictredirects Строгое следование спецификации RFC при перенаправлениях (см. Раздел 15.2.1, «HTTP Redirections») boolean false
useragent Идентификатор агента пользователя (отправляется в заголовке запроса) string 'Zend_Http_Client'
timeout Таймаут соединения в секундах integer 10
httpversion Версия протокола HTTP float (1.1 or 1.0) 1.1
adapter Используемый класс адаптера соединения (см. Раздел 15.3, «Zend_Http_Client - Connection Adapters») mixed 'Zend_Http_Client_Adapter_Socket'
keepalive Включение поддержки соединения keep-alive с сервером. Может быть полезно и повышает поизводительность, если выполняется несколько последовательных запросов к одному и тому же серверу. boolean false

15.1.3. Выполнение базовых HTTP-запросов

Выполнение простых HTTP-запросов с использованием метода request() довольно простое, и редко требуется больше кода, чем в эти три строчки:

Пример 15.2. Выполнение простого запроса GET

<?php
    require_once 'Zend/Http/Client.php';

    $client = new Zend_Http_Client('http://example.org');
    $response = $client->request();
?>

Метод request() принимает один необязательный параметр - метод запроса. Это могут быть методы GET, POST, PUT, HEAD, DELETE, TRACE, OPTIONS или CONNECT, определенные в протоколе HTTP. [1]. Для удобства все они определены как константы класса: Zend_Http_Request::GET, Zend_Http_Request::POST и т.д.

Если метод запроса не был указан, то используемый метод определяется последним вызовом setMethod(). Если setMethod() не был вызван, то по умолчанию используется метод GET (см. пример выше).

Пример 15.3. Использование методов запроса, отличных от GET

<?php
    // Выполнение запроса POST
    $response = $client->request('POST');
    
    // Еще один способ сделать то же самое:
    $client->setMethod(Zend_Http_Client::POST);
    $response = $client->request();
?>

15.1.4. Добавление параметров GET и POST

Добавление параметров GET в HTTP-запрос довольно простое, это может быть сделано посредством определения параметров как часть URL или с использованием метода setParameterGet(). Этот метод принимает имя параметра GET и его значение первый и второй аргументы соответственно. Метод setParameterGet() может также принимать ассоциативный массив пар имя => значение, что удобно, если нужно установить несколько параметров GET.

Пример 15.4. Установка параметров GET

<?php
    // Установка параметра GET с использованием метода setParameterGet
    $client->setParameterGet('knight', 'lancelot');

    // Эвивалентный код с установкой через URL:
    $client->setUri('http://example.com/index.php?knight=lancelot');
    
    // Добавление нескольких параметров в одном вызове
    $client->setParameterGet(array(
        'first_name'  => 'Bender',
        'middle_name' => 'Bending'
        'made_in'     => 'Mexico',
    ));
?>

В то время как параметры GET могут отправляться с любыми методами запроса, параметры POST могут отправляться только в теле запроса POST. Добавление параметров POST к запросу очень похоже на добавление параметров GET и выполняется через метод setParameterPost().

Пример 15.5. Установка параметров POST

<?php
    // Установка параметра POST
    $client->setParameterPost('language', 'fr');
    
    // Установка нескольких параметров POST,
    // один из них - с несколькими значениями
    $client->setParameterPost(array(
        'language'  => 'es',
        'country'   => 'ar',
        'selection' => array(45, 32, 80)
    ));
?>

Заметьте, что отправляя запрос POST, вы можете установить как параметры POST, так и параметры GET. С другой стороны, хотя установка параметров POST для не-POST запросов не вызывает ошибки, она не имеет практического смысла. Если запрос не производится по методу POST, то параметры POST просто игнорируются.

15.1.5. Получение последних запроса и ответа

Zend_Http_Client предоставляет методы для получения последнего отправленного запроса и последнего ответа, полученного через объект клиента. Метод Zend_Http_Client->getLastRequest() не требует параметров и возвращает последний HTTP-запрос, отправленный через объект клиента, в виде строки. Аналогично, Zend_Http_Client->getLastResponse() возвращает последний HTTP-ответ, полученный через объект клиента, в виде объекта Zend_Http_Response.