HttpSocket¶

Faire une requête¶

Vous pouvez utiliser HttpSocket pour créer la plupart des requêtes HTTP avec les différentes méthodes HTTP.

HttpSocket::get($uri, $query, $request)¶

Le paramètre $query peut soit être une chaîne de caractères, soit un tableau de clés et de valeurs. La méthode get fait une simple requête HTTP GET retournant les résultats:

App::uses('HttpSocket', 'Network/Http');

$HttpSocket = new HttpSocket();

// requête chaîne
$results = $HttpSocket->get('https://www.google.com/search', 'q=cakephp');

// requête tableau
$results = $HttpSocket->get('https://www.google.com/search', array('q' => 'cakephp'));

HttpSocket::post($uri, $data, $request)¶

La méthode post fait une simple requête HTTP POST retournant les résultats.

Les paramètres pour la méthode post sont presque les mêmes que pour la méthode get, $uri est l’adresse web où la requête a été faite; $query est la donnée à poster, que ce soit en chaîne, ou en un tableau de clés et de valeurs:

App::uses('HttpSocket', 'Network/Http');

$HttpSocket = new HttpSocket();

// donnée en chaîne
$results = $HttpSocket->post(
    'http://example.com/add',
    'name=test&type=user'
);

// donnée en tableau
$data = array('name' => 'test', 'type' => 'user');
$results = $HttpSocket->post('http://example.com/add', $data);

HttpSocket::put($uri, $data, $request)¶

La méthode put fait une simple requête HTTP PUT retournant les résultats.

Les paramètres pour la méthode put est la même que pour la méthode post().

HttpSocket::delete($uri, $query, $request)¶

La méthode delete fait une requête simple HTTP DELETE retournant les résultats.

Les paramètres pour la méthode delete sont les mêmes que pour la méthode get(). Le paramètre $query peut soit être une chaîne, soit un tableau d’arguments d’une recherche sous forme de chaîne pour la requête.

HttpSocket::patch($uri, $data, $request)¶

La méthode patch fait une simple requête HTTP PATCH retournant les résultats.

Les paramètres pour la méthode patch sont les mêmes que pour la méthode post().

Nouveau dans la version 2.4.

HttpSocket::request($request)¶

La méthode request de base qui est appelée à partir de tous les wrappers (get, post, put, delete). Retourne les résultats de la requête.

$request est un tableau à clé avec des options diverses. Voici le format et les configurations par défaut:

public $request = array(
    'method' => 'GET',
    'uri' => array(
        'scheme' => 'http',
        'host' => null,
        'port' => 80,
        'user' => null,
        'pass' => null,
        'path' => null,
        'query' => null,
        'fragment' => null
    ),
    'auth' => array(
        'method' => 'Basic',
        'user' => null,
        'pass' => null
    ),
    'version' => '1.1',
    'body' => '',
    'line' => null,
    'header' => array(
        'Connection' => 'close',
        'User-Agent' => 'CakePHP'
    ),
    'raw' => null,
    'redirect' => false,
    'cookies' => array()
);

Gérer la réponse¶

Les réponses des requêtes faîtes avec HttpSocket sont des instances de HttpResponse. L’objet vous donne quelques méthodes accessor pour accéder au contenu de la réponse HTTP. Cette classe intègre le ArrayAccess et __toString(), donc vous pouvez continuer en utilisant $http->response en tableau et le retour des méthodes de requête en chaîne:

App::uses('HttpSocket', 'Network/Http');

$http = new HttpSocket();
$response = $http->get('https://cakephp.org');

// Check the body for the presence of a title tag.
$titlePos = strpos($response->body, '<title>');

// Récupère le code de statut pour la réponse.
$code = $response->code;

HttpResponse a les attributs suivants:

• body retourne le corps de la réponse HTTP (normalement le HTML).

• headers retourne un tableau avec les headers.

• cookies retourne un tableau avec les nouveaux cookies (les cookies des autres requêtes ne sont pas stockés ici).

• httpVersion retourne une chaîne avec la version de HTTP (à partir de la première ligne dans la réponse).

• code retourne l’integer avec le code HTTP.

• reasonPhrase retourne la chaîne avec la réponse du code HTTP.

• raw retourne la réponse non changée du serveur.

HttpResponse expose aussi les méthodes suivantes:

• body() retourne le corps.

• isOk() retourne si le code est 200;

• isRedirect() retourne si le code est 301, 302, 303 or 307 et la localisation du header est définie.

• getHeader() vous permet de récupérer les headers, voir la prochaine section.

HTTP/1.1 200 OK
Date: Mon, 16 Apr 2007 04:14:16 GMT
server: CakeHttp Server
content-tyPe: text/html

Date: Mon, 16 Apr 2007 04:14:16 GMT
server: CakeHttp Server
content-tyPe: text/html

// $response est une instance de HttpResponse
// récupère le header Content-Type.
$response->getHeader('Content-Type');

// Récupère la date
$response->getHeader('date');

<?php
App::uses('HttpSocket', 'Network/Http');

$HttpSocket = new HttpSocket();
$response = $HttpSocket->get('http://example.com/redirecting_url', array(), array('redirect' => true));

$socket = new HttpSocket(array(
    'ssl_allow_self_signed' => true
));

App::uses('HttpResponse', 'Network/Http');

class YourResponse extends HttpResponse {

    public function parseResponse($message) {
        parent::parseResponse($message);
        // Make what you want
    }
}

App::uses('HttpSocket', 'Network/Http');

$http = new HttpSocket();
$http->responseClass = 'YourResponse';

App::uses('HttpSocket', 'Network/Http');

$http = new HttpSocket();
$f = fopen(TMP . 'bakery.xml', 'w');
$http->setContentResource($f);
$http->get('https://bakery.cakephp.org/comments.rss');
fclose($f);

Utiliser l’authentification¶

HttpSocket supporte des méthodes d’authentification HTTP Basic et Digest. Vous pouvez maintenant créer des objets d’authentification personnalisés pour supporter des protocoles comme OAuth. Pour utiliser un système d’authentification, vous devez configurer l’instance HttpSocket:

App::uses('HttpSocket', 'Network/Http');

$http = new HttpSocket();
$http->configAuth('Basic', 'user', 'password');

Ce qui est au-dessus configurerait l’instance HttpSocket pour utiliser l’authentification Basic en utilisant user et password en credentials.

class YourMethodAuthentication {

/**
 * Authentication
 *
 * @param HttpSocket $http
 * @param array $authInfo
 * @return void
 */
    public static function authentication(HttpSocket $http, &$authInfo) {
        // Faire quelque chose, par exemple définir la valeur $http->request['header']['Authentication']
    }

}

$http->configAuth('YourMethod', array('config1' => 'value1', 'config2' => 'value2'));
$http->get('http://secure.your-site.com');

class YourMethodAuthentication {

/**
 * Authentication
 *
 * @param HttpSocket $http
 * @param array $authInfo
 * @return void
 */
    public static function authentication(HttpSocket $http, &$authInfo) {
        // Faire quelque chose, par exemple définir ma valeur $http->request['header']['Authentication']
    }

/**
 * Proxy Authentication
 *
 * @param HttpSocket $http
 * @param array $proxyInfo
 * @return void
 */
    public static function proxyAuthentication(HttpSocket $http, &$proxyInfo) {
        // Faire quelque chose, par exemple définir la valeur $http->request['header']['Proxy-Authentication']
    }

}