Previous Next

Zend_XmlRpc_Client

導入

Zend Framework では、クライアントとしてリモートの XML-RPC サービスを使用することもサポートしています。そのためには Zend_XmlRpc_Client パッケージを使用します。 主な機能には、PHPXML-RPC の間の型変換やサーバのプロキシオブジェクト、 そしてサーバが提供する機能を調べることなどがあります。

メソッドのコール

Zend_XmlRpc_Client のコンストラクタは、 リモート XML-RPC サーバの URL を最初の引数として受け取ります。 返されたインスタンスを使用して、 その場所からさまざまなリモートメソッドを実行します。

リモートメソッドを XML-RPC クライアントからコールするには、 インスタンスを作成した後で call() メソッドをコールします。 以下の例では Zend Framework のウェブサイト上にあるデモ用の XML-RPC サーバを使用します。Zend_XmlRpc のテストや調査のために、このサーバを使用できます。

Example #1 XML-RPC メソッドのコール

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

echo $client->call('test.sayHello');

// hello

リモートメソッドのコールによって返される XML-RPC の値は、 自動的に PHP のネイティブ型に変換されます。 上の例では PHPString が返されるので、 それをそのまま使用できます。

call() メソッドの最初のパラメータは、 コールするリモートメソッドの名前です。 そのリモートメソッドが何らかのパラメータを要求する場合は、それを call() の二番目のオプションのパラメータで指定します。 このパラメータには、リモートメソッドに渡す値を配列で指定します。

Example #2 パラメータを指定した XML-RPC メソッドのコール

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$arg1 = 1.1;
$arg2 = 'foo';

$result = $client->call('test.sayHello', array($arg1, $arg2));

// $result はネイティブな PHP の型になります

リモートメソッドがパラメータを要求していない場合は、 このパラメータには何も指定しません。あるいは空の array() を渡します。リモートメソッドに渡すパラメータの配列には、 ネイティブの PHP 型と Zend_XmlRpc_Value オブジェクトの両方を使用できます。それらを混用することも可能です。

call() メソッドは自動的に XML-RPC のレスポンスを変換し、 同等な PHP ネイティブ型にして返します。返り値を Zend_XmlRpc_Response オブジェクトとして取得するには、 このメソッドの後で getLastResponse() をコールします。

型およびその変換

リモートメソッドの中にはパラメータが必要なものがあります。 必要なパラメータは、Zend_XmlRpc_Clientcall() メソッドの二番目のパラメータとして配列で指定します。 パラメータを渡す方法は 2 通りあります。PHP のネイティブ型 (これは自動的に変換されます) で渡すか、 対応する XML-RPC 型 (Zend_XmlRpc_Value オブジェクトのひとつ) で渡すかのいずれかです。

PHP ネイティブ変数をパラメータとして渡す

call() のパラメータをネイティブの PHP 型で渡します。つまり StringintegerfloatBooleanArray あるいは object で渡すということです。 このとき、PHP のネイティブ型は自動的に検出され、 以下の表にしたがって XML-RPC 型に変換されます。

PHP と XML-RPC の間の型変換
PHP ネイティブ型 XML-RPC
integer int
Zend_Crypt_Math_BigInteger i8
double double
boolean boolean
string string
null nil
array array
associative array struct
object array

Note: 空の配列はどの型に変換されるの?

空の配列を XML-RPC メソッドに渡すことには問題があります。 それが array と struct のどちらにでもとれるからです。 Zend_XmlRpc_Client は、このような状況を検出した場合にはサーバの system.methodSignature メソッドにリクエストを送り、どの XML-RPC 型に変換すべきかを判断します。

しかし、このやりかた自体にも別の問題があります。 まず、サーバが system.methodSignature をサポートしていない場合には「リクエストに失敗した」 記録がサーバに残ってしまいます。この場合、 Zend_XmlRpc_Client は値を XML-RPC の array 型に変換します。 さらに、このやりかたを使用すると 「配列形式の引数を指定してコールすると、 毎回リモートサーバへの余計な呼び出しが発生する」 ということになります。

この仕組みを無効にするには、XML-RPC コールの前に setSkipSystemLookup() メソッドをコールします。

$client->setSkipSystemLookup(true);
$result = $client->call('foo.bar', array(array()));

Zend_XmlRpc_Value オブジェクトをパラメータとして渡す

パラメータを表す Zend_XmlRpc_Value のインスタンスを作成し、XML-RPC の型を指定することもできます。 このようにする理由には次のようなものがあります。

  • プロシージャに正しい型で渡されることを確実にしたいことがある (例えば、integer を要求しているプロシージャに対して データベースから取得した文字列を渡したい場合など)。

  • プロシージャが base64 型や dateTime.iso8601 型を要求していることがある (これらは PHP のネイティブ型には存在しません)。

  • 自動変換が失敗する場合 (例えば、空の XML-RPC 構造体をパラメータとして渡すことを考えましょう。 これは、PHP では空の配列に対応します。しかし、 空の配列をパラメータとして渡すと、それが自動変換されたときに XML-RPC の array になってしまいます。なぜなら、 空の配列は連想配列ではないからです)。

Zend_XmlRpc_Value オブジェクトを作成する方法は 二通りあります。Zend_XmlRpc_Value のサブクラスのインスタンスを直接作成するか、 あるいは静的ファクトリメソッド Zend_XmlRpc_Value::getXmlRpcValue() を使用します。

Zend_XmlRpc_Value オブジェクトと対応する XML-RPC 型
XML-RPC 対応する Zend_XmlRpc_Value 定数 Zend_XmlRpc_Value オブジェクト
int Zend_XmlRpc_Value::XMLRPC_TYPE_INTEGER Zend_XmlRpc_Value_Integer
i8 Zend_XmlRpc_Value::XMLRPC_TYPE_I8 Zend_XmlRpc_Value_BigInteger
ex:i8 Zend_XmlRpc_Value::XMLRPC_TYPE_APACHEI8 Zend_XmlRpc_Value_BigInteger
double Zend_XmlRpc_Value::XMLRPC_TYPE_DOUBLE Zend_XmlRpc_Value_Double
boolean Zend_XmlRpc_Value::XMLRPC_TYPE_BOOLEAN Zend_XmlRpc_Value_Boolean
string Zend_XmlRpc_Value::XMLRPC_TYPE_STRING Zend_XmlRpc_Value_String
nil Zend_XmlRpc_Value::XMLRPC_TYPE_NIL Zend_XmlRpc_Value_Nil
ex:nil Zend_XmlRpc_Value::XMLRPC_TYPE_APACHENIL Zend_XmlRpc_Value_Nil
base64 Zend_XmlRpc_Value::XMLRPC_TYPE_BASE64 Zend_XmlRpc_Value_Base64
dateTime.iso8601 Zend_XmlRpc_Value::XMLRPC_TYPE_DATETIME Zend_XmlRpc_Value_DateTime
array Zend_XmlRpc_Value::XMLRPC_TYPE_ARRAY Zend_XmlRpc_Value_Array
struct Zend_XmlRpc_Value::XMLRPC_TYPE_STRUCT Zend_XmlRpc_Value_Struct

Note: 自動変換

新しい Zend_XmlRpc_Value オブジェクトを作成する際には、 その値は PHP の型として設定されます。この PHP の型は、 PHP のキャスト機能によって変換されます。 たとえば、Zend_XmlRpc_Value_Integer に文字列を渡すと、(int)$value のように変換されます。

サーバプロキシオブジェクト

リモートメソッドを XML-RPC クライアントからコールするもうひとつの方法は、 サーバプロキシを使用することです。 サーバプロキシとはリモートの XML-RPC 名前空間のプロキシとなる PHP オブジェクトで、ネイティブな PHP オブジェクトと可能な限り同じように扱えるようにしたものです。

サーバプロキシのインスタンスを作成するには、 Zend_XmlRpc_Client のインスタンスメソッド getProxy() をコールします。これは Zend_XmlRpc_Client_ServerProxy のインスタンスを返します。 サーバプロキシに対するあらゆるメソッドコールはリモートに転送され、 パラメータも通常の PHP メソッドと同じように渡せます。

Example #3 デフォルト名前空間のプロキシ

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$server = $client->getProxy();           // デフォルトの名前空間のプロキシを作成します

$hello = $server->test->sayHello(1, 2);  // test.Hello(1, 2) は "hello" を返します

getProxy() のオプションの引数で、 リモートサーバのどの名前空間をプロキシするかを指定できます。 名前空間を指定しなかった場合は、デフォルトの名前空間をプロキシします。 次の例では、test 名前空間がプロキシの対象となります。

Example #4 任意の名前空間のプロキシ

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$test  = $client->getProxy('test');     // "test" 名前空間のプロキシを作成します

$hello = $test->sayHello(1, 2);         // test.Hello(1,2) は "hello" を返します

リモートサーバが入れ子状の名前空間をサポートしている場合は、 サーバプロキシでもそれを使用できます。たとえば、 上の例のサーバがメソッド test.foo.bar() を保持している場合は、$test->foo->bar() のようにコールします。

エラー処理

XML-RPC のメソッドコールで発生する可能性のあるエラーには、二種類あります。 HTTP のエラーと XML-RPC の fault です。Zend_XmlRpc_Client はこれらの両方を理解するので、それぞれ独立して検出と処理が可能です。

HTTP エラー

HTTP エラーが発生した場合、 つまり、たとえばリモート HTTP サーバが 404 Not Found を返したような場合に Zend_XmlRpc_Client_HttpException がスローされます。

Example #5 HTTP エラーの処理

$client = new Zend_XmlRpc_Client('http://foo/404');

try {

    $client->call('bar', array($arg1, $arg2));

} catch (Zend_XmlRpc_Client_HttpException $e) {

    // $e->getCode() は 404 を返します
    // $e->getMessage() は "Not Found" を返します

}

XML-RPC クライアントの使用法にかかわらず、HTTP エラーが発生すると必ず Zend_XmlRpc_Client_HttpException がスローされます。

XML-RPC Fault

XML-RPC の fault は、PHP の例外と似たものです。これは XML-RPC メソッドのコールから返される特別な型で、 エラーコードとエラーメッセージを含みます。XML-RPC の fault は、Zend_XmlRpc_Client の使用場面によって処理方法が異なります。

call() メソッドや サーバプロキシオブジェクトを使用している場合には、 XML-RPC の fault が発生すると Zend_XmlRpc_Client_FaultException がスローされます。 この例外のコードとメッセージは、もとの XML-RPC の fault レスポンスの値に対応するものとなります。

Example #6 XML-RPC Fault の処理

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

try {

    $client->call('badMethod');

} catch (Zend_XmlRpc_Client_FaultException $e) {

    // $e->getCode() は 1 を返します
    // $e->getMessage() は "Unknown method" を返します

}

call() メソッドを使用してリクエストを作成した場合は、 fault の際に Zend_XmlRpc_Client_FaultException がスローされます。fault を含む Zend_XmlRpc_Response オブジェクトを取得するには getLastResponse() をコールします。

doRequest() メソッドでリクエストを作成した場合は、 例外はスローされません。そのかわりに、falut を含む Zend_XmlRpc_Response オブジェクトを返します。 これを調べるには、 Zend_XmlRpc_Response のインスタンスメソッド isFault() を使用します。

サーバのイントロスペクション

XML-RPC サーバの中には、XML-RPCsystem. 名前空間で デファクトのイントロスペクションメソッドをサポートしているものもあります。 Zend_XmlRpc_Client は、この機能を持つサーバもサポートしています。

Zend_XmlRpcClientgetIntrospector() メソッドをコールすると、 Zend_XmlRpc_Client_ServerIntrospection のインスタンスを取得できます。 これを使用してサーバのイントロスペクションを行います。

リクエストからレスポンスへ

Zend_XmlRpc_Client のインスタンスメソッド call() 中で行われていることは、 まずリクエストオブジェクト (Zend_XmlRpc_Request) を作成し、 それを別のメソッド doRequest() で送信し、 その結果返されるレスポンスオブジェクト (Zend_XmlRpc_Response) を取得するということです。

doRequest() メソッドは、それ単体で直接使用することもできます。

Example #7 リクエストからレスポンスへの処理

$client = new Zend_XmlRpc_Client('http://framework.zend.com/xmlrpc');

$request = new Zend_XmlRpc_Request();
$request->setMethod('test.sayHello');
$request->setParams(array('foo', 'bar'));

$client->doRequest($request);

// $server->getLastRequest() は Zend_XmlRpc_Request のインスタンスを返します
// $server->getLastResponse() は Zend_XmlRpc_Response のインスタンスを返します

クライアントから XML-RPC メソッドのコールが ( call() メソッド、 doRequest() メソッドあるいはサーバプロキシによって) 行われた場合は、最後のリクエストオブジェクトおよびその応答が常に getLastRequest() および getLastResponse() で取得できます。

HTTP クライアントのテスト

これまでのすべての例では、HTTP クライアントの設定を行いませんでした。 このような場合、Zend_Http_Client の新しいインスタンスがデフォルトのオプションで作成され、それを自動的に Zend_XmlRpc_Client で使用します。

HTTP クライアントは、いつでも getHttpClient() メソッドで取得できます。 たいていの場合はデフォルトの HTTP クライアントで用が足りるでしょう。 しかし、 setHttpClient() を使用することで、 別の HTTP クライアントのインスタンスを使うこともできます。

setHttpClient() は、特に単体テストの際に有用です。 Zend_Http_Client_Adapter_Test と組み合わせることで、 テスト用のリモートサービスのモックを作成できます。 この方法を調べるには、Zend_XmlRpc_Client 自体の単体テストを参照ください。

Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Amf
導入
Zend_Amf_Server
Zend_Application
導入
Zend_Application クイックスタート
Theory of Operation
コア機能
利用できるリソースプラグイン
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
導入
Captcha の方法
CAPTCHA アダプタ
Zend_CodeGenerator
導入
Zend_CodeGeneratorサンプル
Zend_CodeGeneratorリファレンス
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
導入
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
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_Db_Table_Definition
Zend_Debug
変数の出力
Zend_Dojo
導入
Zend_Dojo_Data: dojo.data エンベロープ
Dojo ビューヘルパー
Dojoフォーム要素とデコレーター
Zend_Dojo build layer support
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_Feed_Reader
Zend_File
Zend_File_Transfer
Zend_File_Transfer 用のバリデータ
Filters 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
導入
AuthSub による認証
Using the Book Search Data API
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Using Google Health
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
Picasa Web Albums の使用法
YouTube Data API の使用法
Gdata の例外処理
Zend_Http
導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
前バージョンからの移行
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
Zend_Json の高度な使用法
XML から JSON への変換
Zend_Json_Server - JSON-RPCサーバー
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
API概要
利用シナリオ
ツール
Zend_Ldap_Nodeを使用してLDAPツリーへのオブジェクト指向アクセス
LDAPサーバから情報を取得
LDIFへ、または、からのLDAPデータシリアライズ
Zend_Loader
ファイルやクラスの動的な読み込み
The Autoloader
Resource Autoloaders
プラグインのロード
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_Navigation
導入
画面
Containers
Migrating from Previous Versions
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
導入
使用法
設定
高度な使用法
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ページの操作
描画
Interactive Features
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_ProgressBar
Zend_ProgressBar
Zend_Queue
導入
使用例
フレームワーク
アダプタ
Zend_Queueのカスタマイズ
Stomp
Zend_Reflection
導入
Zend_Reflectionサンプル
Zend_Reflectionリファレンス
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_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Stroage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2:リージョンおよび利用可能ゾーン
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Amazon_Sqs
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_Twitter
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDLアクセッサ
自動検出
Zend_Tag
導入
Zend_Tag_Cloud
Zend_Test
導入
Zend_Test_PHPUnit
Zend_Test_PHPUnit_Db
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Tool_Framework
導入
CLIツールの使用
アーキテクチャ
Zend_Tool_Frameworkを利用してプロバイダを作成する
出荷されたシステムプロバイダー
Extending and Configuring Zend_Tool_Framework
Zend_Tool_Project
導入
プロジェクトを作成
Zend Toolプロジェクトプロバイダー
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
ソースファイルの作成
翻訳用の追加機能
Plural notations for Translation
以前のバージョンからの移行
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 のシステム要件
導入
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
Zend Framework Documentation Standard
Overview
Documentation File Formatting
Recommendations
Zend Framework MVC アプリケーションのために推奨されるプロジェクト構造
概要
推奨されるプロジェクト・ディレクトリ構造
モジュール構造
リライト設定ガイド
Zend Framework Performance Guide
導入
クラスの読み込み
Zend_Dbパフォーマンス
国際化(i18n)とローカライズ(l10n)
ビューのレンダリング
著作権に関する情報