Previous Next

Zend_Http_Response

導入

Zend_Http_Response は、HTTP レスポンスに簡単にアクセスできるようにします。 また、HTTP レスポンスメッセージをパースするための静的メソッド群も提供します。 通常は、Zend_Http_Response は Zend_Http_Client リクエストの返す結果として使用します。

ほとんどの場合は、Zend_Http_Response オブジェクトのインスタンスを作成するには factory() メソッドを使用します。これは、HTTP レスポンスメッセージを含む文字列を受け取って新しい Zend_Http_Response オブジェクトを返します。

Example #1 ファクトリメソッドを使用した Zend_Http_Response オブジェクトの作成



            

コンストラクタを使用して新しいオブジェクトを作成することもできます。 その際には、レスポンスの全パラメータを指定します。

public function __construct($code, $headers, $body = null, $version = '1.1', $message = null)

  • $code: HTTP レスポンスコード (たとえば 200 や 404 など)。

  • $headers: HTTP レスポンスヘッダの連想配列 (たとえば 'Host' => 'example.com' など)。

  • $body: レスポンス本文の文字列。

  • $version: HTTP レスポンスのバージョン (通常は 1.0 あるいは 1.1)。

  • $message: HTTP レスポンスメッセージ (たとえば 'OK' や 'Internal Server Error' など)。 指定しなかった場合は、レスポンスコードに応じたメッセージが設定されます。

真偽チェック用のメソッド

Zend_Http_Response のインスタンスを取得すると、 レスポンスの種類を調べるためのメソッドが使用できるようになります。 これらのメソッドは、すべて true あるいは false を返します。

  • Boolean isSuccessful(): リクエストが成功したかどうかを調べます。 HTTP レスポンスコードが 1xx か 2xx であった場合に TRUE を返します。

  • Boolean isError(): レスポンスコードがエラーを意味しているかどうかを調べます。 HTTP レスポンスコードが 4xx (クライアントのエラー) あるいは 5xx (サーバのエラー) であった場合に TRUE を返します。

  • Boolean isRedirect(): レスポンスがリダイレクトされているかどうかを調べます。 HTTP レスポンスコードが 3xx であった場合に TRUE を返します。

Example #2 isError() メソッドの使用によるレスポンスの検証

isError()) {
  echo "データ転送エラー。\n"
  echo "サーバからの応答: " . $response->getStatus() . " " . $response->getMessage() . "\n";
}
// .. ここでレスポンスを処理します...

アクセス用メソッド群

レスポンスオブジェクトの本来の目的は、レスポンスパラメータに簡単にアクセスすることです。

  • int getStatus(): HTTP レスポンスステータスコード (たとえば 200 や 504 など) を取得します。

  • string getMessage(): HTTP レスポンスステータスのメッセージ (たとえば "Not Found" や "Authorization Required" など) を取得します。

  • string getBody(): HTTP レスポンス本文をデコードしたものを取得します。

  • string getRawBody(): そのままの状態の、おそらくエンコードされている HTTP レスポンス本文を取得します。たとえば GZIP などでエンコードされていたとしても、 それはデコードされません。

  • array getHeaders(): HTTP レスポンスヘッダを、連想配列形式 (たとえば 'Content-type' => 'text/html' など) で取得します。

  • string|array getHeader($header): $header で指定した、 特定の HTTP レスポンスヘッダを取得します。

  • string getHeadersAsString($status_line = true, $br = "\n"): ヘッダ全体を文字列として取得します。$status_line が true の場合 (デフォルト) は、 最初のステータス行 (たとえば "HTTP/1.1 200 OK" など) も返されます。 改行は $br パラメータで指定します (たとえば "<br />" などにもできます)。

  • string asString($br = "\n"): レスポンスメッセージ全体を文字列として取得します。 改行は $br パラメータで指定します (たとえば "<br />" などにもできます)。

Example #3 Zend_Http_Response へのアクセス用メソッドの使用

getStatus() == 200) {
  echo "リクエストの結果は次のようになりました。
"; echo $response->getBody(); } else { echo "データの取得時にエラーが発生しました。
"; echo $response->getStatus() . ": " . $response->getMessage(); }

Note: 常に返り値をチェックする

レスポンスには同じヘッダを複数含めることができるので、 getHeader() メソッドや getHeaders() メソッドの返す結果は 文字列の場合もあれば文字列の配列となる場合もあります。 返された値が文字列なのか配列なのかを常にチェックするようにしましょう。

Example #4 レスポンスヘッダへのアクセス

getHeader('Content-type');
if (is_array($ctype)) $ctype = $ctype[0];

$body = $response->getBody();
if ($ctype == 'text/html' || $ctype == 'text/xml') {
  $body = htmlentities($body);
}

echo $body;

静的 HTTP レスポンスパーサ

Zend_Http_Response クラスには、内部で使用するメソッドもいくつか含まれています。 これは、HTTP レスポンスメッセージを処理したりパースしたりするためのものです。 これらのメソッドは静的メソッドとして公開されています。 つまり外部からでも使用できるということです。特にインスタンスを作成しなくても、 レスポンスの一部を抽出したりなどといった目的で使用可能です。

  • int Zend_Http_Response::extractCode($response_str): HTTP レスポンスコード (たとえば 200 や 404 など) を $response_str から抽出し、それを返します。

  • string Zend_Http_Response::extractMessage($response_str): HTTP レスポンスメッセージ (たとえば "OK" や "File Not Found" など) を $response_str から抽出し、それを返します。

  • string Zend_Http_Response::extractVersion($response_str): HTTP バージョン (たとえば 1.1 や 1.0 など) を $response_str から抽出し、それを返します。

  • array Zend_Http_Response::extractHeaders($response_str): HTTP レスポンスヘッダを $response_str から抽出し、それを配列で返します。

  • string Zend_Http_Response::extractBody($response_str): HTTP レスポンス本文を $response_str から抽出し、それを返します。

  • string Zend_Http_Response::responseCodeAsText($code = null, $http11 = true): レスポンスコード $code に対応する、標準的な HTTP レスポンスメッセージを取得します。 たとえば $code が 500 の場合は "Internal Server Error" を返します。 $http11 が true の場合 (デフォルト) は HTTP/1.1 のメッセージを、 そうでない場合は HTTP/1.0 のメッセージを返します。 $code を省略した場合は、このメソッドは、すべての既知の HTTP レスポンスコードを連想配列 (code => message) で返します。

パーサメソッド以外にも、このクラスには 一般的な HTTP レスポンスエンコーディングに対応したデコーダが含まれています。

  • string Zend_Http_Response::decodeChunkedBody($body): "Content-Transfer-Encoding: Chunked" の本文をデコードします。

  • string Zend_Http_Response::decodeGzip($body): "Content-Encoding: gzip" の本文をデコードします。

  • string Zend_Http_Response::decodeDeflate($body): "Content-Encoding: deflate" の本文をデコードします。

Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
Introduction
Captcha Operation
Captcha Adapters
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Console_Getopt
Getopt について
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ: Zend_Controller_Router_Rewrite
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
以前のバージョンからの移行
Zend_Currency
Zend_Currency について
通貨の操作方法
以前のバージョンからの移行
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
導入
Zend_Debug
変数の出力
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helpers
Dojo Form Elements and Decorators
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_File
Zend_File_Transfer
Validators for Zend_File_Transfer
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
Gdata について
AuthSub による認証
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
YouTube Data API の使用法
Picasa Web Albums の使用法
Gdata の例外処理
Zend_Http
Zend_Http_Client - 導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
JSON オブジェクト
XML から JSON への変換
Zend_Json_Server - JSON-RPC server
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
Zend_Loader
ファイルやクラスの動的な読み込み
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
ロケールがサポートする言語
ロケールがサポートする地域
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
Introduction
Usage
Configuration
Advanced usage
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ドキュメントのページ
描画
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Server
導入
Zend_Server_Reflection
Zend_Service
導入
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
導入
Zend_Service_StrikeIron
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Accessor
AutoDiscovery. Introduction
Class autodiscovering.
Functions autodiscovering.
Autodiscovering. Datatypes.
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
Zend_Uri
Zend_Uri
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework のシステム要件
PHP のバージョン
PHP の拡張モジュール
Zend Framework のコンポーネント
Zend Framework の依存性
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
著作権に関する情報