Content
2004/11/15 05:08:38XMLRPCfor5_6 - XML系モジュールが使えない環境のためのXML-RPCクライアント
■ XMLRPCfor5_6 - XML系モジュールが使えない環境のためのXML-RPCクライアント
NAME 名称
XMLRPCfor5_6 - XML系モジュールが使えない環境のためのXML-RPCクライアント
SYNOPSIS 概要
use XMLRPCfor5_6;
$client = XMLRPCfor5_6->new;
$client->proxy('http://domain.com/api');
$req = $client->request($method, $value, \@array, \%struct);
$res = $client->call($req);
unless ( $res->is_success ) { print $res->error_code; exit; }
print $res->as_string; # 受け取ったXMLの原文
$result = $res->result; # 受け取ったXMLを解析した結果のデータ
DESCRIPTION 説明
通常、XML-RPCをPerlで扱うには、そのものXMLRPC::LiteやFrontier::Clientのようなモジュールを使うのが最も問題がありません。 けれど、中にはそういうモジュールがインストールされていないなどの問題を抱えた環境もある訳で、そう言った環境のためにインストール作業なしで使えるように作られたのがこのモジュールです。 内部的に使われているのは、LWP::UserAgentモジュールと、このモジュールと同じ作者によるTagモジュールだけです。
METHODS
new
コンストラクタです。
proxy
問い合わせ先を設定します。引数なしで呼び出した場合は、情報取得メソッドとして扱われます。
ua
ユーザーエージェントを設定します。
引数に与えられるのは、LWP::UserAgentクラス（とその子クラス）のオブジェクトに限定してください。 引数なしならば、設定されているオブジェクト自身が返ってきます。 もしオブジェクトを作った直後に引数なしで呼び出した場合は、オブジェクトが自動的にLWP::UserAgentのオブジェクトを作成します。 これは、プログラムの他の部分でLWP::UserAgentクラスのオブジェクトを使っていた場合、共有することでメモリーの節約を狙うための仕様です。
tag
- 説明：タグ生成オブジェクトを取り扱います。
- 引数：$object->tagとすると、タグが戻ってくるようなオブジェクト
- 返値：現在設定されているオブジェクト
- 解説
XMLを取り扱う上で、タグの生成は重要な要素です。 タグ生成で最もバグが少ないと思われるのは、CGIモジュールです。 しかしCGIモジュールは非常に大きく、これをわずかな問い合わせのために不必要な部分も含めてコンパイルするのはリソースを圧迫するでしょう。 そこで、CGIモジュールからタグ生成機能のみを切り出した不完全クローンであるところのTagモジュールを作成しました。 オブジェクトを作った直後に、Tagクラスのオブジェクトをこのメソッドを通じて与えてください。そうすれば、遥かに少ないメモリーで動作するでしょう。 もし、最初にオブジェクトを与えずに引数なしでこのメソッドを呼び出してしまった場合は、容赦なくCGIモジュールがコンパイルされます。
request
あらかじめこのメソッドでリクエストを作成しておきます。そうすることで、同じリクエストを送る際に何度も再作成せずに済みます。 引数には、メソッドを先頭に送るデータを配列で入れてください。スカラーはそのまま、配列リファレンスとハッシュリファレンスはそれぞれarrayとstructに変換されます。
call
- 説明：APIを呼び出します。
- requestメソッドで作成したリクエストオブジェクト
- 返値：結果を内包したオブジェクト
- 解説
メインになるメソッドです。
$client = XMLRPCfor5_6->new;
$client->proxy('url');
$request = $client->request('method', @data);
$responce = $client->call($request);
引数として、requestメソッドと同じものを与えると、内部でrequestメソッドを呼び出してからコールを始めます。
なお、得られたオブジェクトに対して、resultメソッドを実行すると、得られたXMLを解析した配列なりハッシュリファレンスなりが得られます。この出力内容はUTF-8のままなので、表示の際には注意してください。