HttpSocket¶

リクエストの作成¶

異なる HTTP メソッドの多くの種類の HTTP リクエストを作成するために HttpSocket が使えます。

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

$query パラメータは、クエリー文字列もしくは、キーとあたいの配列のどちらかです。 get メソッドは、シンプルな HTTP の GET リクエストの結果を返します。

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

$HttpSocket = new HttpSocket();

// 文字列クエリー
$results = $HttpSocket->get('https://www.google.com/search', 'q=cakephp');

// 配列クエリー
$results = $HttpSocket->get('https://www.google.com/search', array('q' => 'cakephp'));

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

post メソッドは、シンプルな HTTP の POST リクエストの結果を返します。

post メソッドのパラメータは、おおよそ get メソッドと同じです。 $url は、 リクエストを送るウェブのアドレスです。 $query は、ポストするデータで、文字列か キーと値の配列です。

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

$HttpSocket = new HttpSocket();

// 文字列データ
$results = $HttpSocket->post(
    'http://example.com/add',
    'name=test&type=user'
);

// 配列データ
$data = array('name' => 'test', 'type' => 'user');
$results = $HttpSocket->post('http://example.com/add', $data);

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

put メソッドは、シンプルな HTTP の PUT リクエストの結果を返します。

put メソッドのパラメータは、 post() メソッドと同じです。

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

delete メソッドは、シンプルな HTTP の DELETE リクエストの結果を返します。

delete メソッドのパラメータは、 get() メソッドと同じです。 $query パラメータは、リクエストのための文字列か、 クエリ文字列の配列です。

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

patch メソッドは、シンプルな HTTP の PATCH リクエストの結果を返します。

patch メソドのパラメータは、 post() メソッドと同じです。

バージョン 2.4 で追加.

HttpSocket::request($request)¶

基礎となる request メソッドは、すべてのラッパー (get, post, put, delete) から呼ばれます。リクエストの結果を返します。

$request は、いろいろなオプションのキーを持つ配列です。以下がデフォルトの設定と フォーマットです。

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

レスポンスの処理¶

HttpSocket を使ったリクエストからのレスポンスは、 HttpResponse のインスタンスです。 このオブジェクトは、HTTP レスポンスの内容にアクセスするための、いくつかのアクセッサーメソッドを 持っています。このクラスは ArrayAccess と __toString() を実装していますので、 $http->response を配列として使用でき、リクエストメソッドの戻り値を 文字列として使用できます。

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

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

// タイトルタグの存在をチェック
$titlePos = strpos($response->body, '<title>');

// レスポンスのステータスコードを取得
$code = $response->code;

HttpResponse は以下の属性を持ちます。

• body は HTTP レスポンスのボディを返します (通常の HTML)。

• headers は、ヘッダーの配列を返します。

• cookies は、新しいクッキーの配列を返します (他のリクエストのクッキーは保存されません)。

• httpVersion は、HTTP バージョンを文字列で返します (レスポンスの１行目から)。

• code は、HTTP ステータスコードを整数で返します。

• reasonPhrase は、HTTP ステータスコードと一緒の文字列を返します。

• raw は、手を加えていないサーバーからのレスポンスを返します。

HttpResponse は、以下のメソッドを持ちます。

• body() は、ボディを返します。

• isOk() は、ステータスコードが 200 かどうかを返します。

• isRedirect() は、ステータスコードが 301, 302, 303 もしくは 307 で Location ヘッダーがセットされているかどうかを返します。

• getHeader() は、ヘッダーを取得します。次のセクションをご覧ください。

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 は HttpResponse のインスタンス。
// Content-Type を取得
$response->getHeader('Content-Type');

// 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);

認証の利用¶

HttpSocket は、 HTTP ベーシック認証とダイジェスト認証に対応しています。 また、OAuth のようなプロトコルに対応するために独自の認証オブジェクトを作成することができます。 任意の認証システムを利用するためには、 HttpSocket インスタンスを設定する必要があります。

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

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

上記は、 user と password を証明情報としてベーシック認証 のための HttpSocket インスタンスの設定です。

class YourMethodAuthentication {

/**
 * 認証
 *
 * @param HttpSocket $http
 * @param array $authInfo
 * @return void
 */
    public static function authentication(HttpSocket $http, &$authInfo) {
        // 何かをします。例えば、 $http->request['header']['Authentication'] の値をセット。
    }

}

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

class YourMethodAuthentication {

/**
 * 認証
 *
 * @param HttpSocket $http
 * @param array $authInfo
 * @return void
 */
    public static function authentication(HttpSocket $http, &$authInfo) {
        // 何かします。例えば $http->request['header']['Authentication'] の値をセット。
    }

/**
 * プロクシ認証
 *
 * @param HttpSocket $http
 * @param array $proxyInfo
 * @return void
 */
    public static function proxyAuthentication(HttpSocket $http, &$proxyInfo) {
        // 何かします。例えば $http->request['header']['Proxy-Authentication'] の値をセット。
    }

}