Previous Next

Zend_Service_StrikeIron

Zend_Service_StrikeIron は、StrikeIron ウェブサービス用の PHP 5 クライアントです。以下のセクションを参照ください。

概要

» StrikeIron は、さまざまな商用データサービス ("Data as a Service") を提供しています。たとえば Online Sales Tax, Currency Rates, Stock Quotes, Geocodes, Global Address Verification, Yellow/White Pages, MapQuest Driving Directions, Dun & Bradstreet Business Credit Checks などのサービスがあります。

StrikeIron ウェブサービスの各サービスは、標準の SOAP (および REST) API を共有しています。これにより、複数のサービスを統合して管理するのが簡単になります。 StrikeIron はまた、すべてのサービスの支払いを単一のアカウントで管理しています。 ソリューションプロバイダにとって完璧な環境といえます。 » http://www.strikeiron.com/sdp で、フリーなウェブサービスを試してみましょう。

StrikeIron のサービスは、 » PHP 5 の SOAP 拡張モジュール のみでも使用することができるでしょう。 しかし、StrikeIron をこの方法で使用すると、 真の PHP 風インターフェイスを活用することができません。 Zend_Service_StrikeIron コンポーネントは、SOAP 拡張モジュールの上にもう一枚薄い皮をかぶせることによって、 StrikeIron のサービスをより便利かつ PHP らしく使えるようにしています。

Note:

Zend_Service_StrikeIron を使うには、 PHP 5 の SOAP 拡張モジュールがインストールされて有効になっている必要があります。

Zend_Service_StrikeIron コンポーネントが提供する機能を以下にまとめます。

  • StrikeIron の認証情報の一元管理により、 さまざまな StrikeIron サービスで使用可能。

  • StrikeIron のさまざまな登録情報 (ライセンスの状態や残りの使用回数など) の標準的な方法での取得。

  • PHP のラッパークラスを作成しなくても、WSDL だけで StrikeIcon サービスが使用可能。 また、ラッパーを作成することで、 より便利なインターフェイスを使用することも可能。

  • StrikeIron のサービスのうち、人気のある 3 つについてのラッパー。

StrikeIron への登録

Zend_Service_StrikeIron を使用するには、まず StrikeIron 開発者アカウントを取得するために » 登録 する必要があります。

登録したら、StrikeIron のユーザ名とパスワードを受け取ります。 Zend_Service_StrikeIron で StrikeIron に接続する際には、 このユーザ名とパスワードを使用します。

また、StrikeIron の Super Data Pack Web Service にも » 登録 する必要があります。

どちらの登録処理も無料です。 StrikeIron のウェブサイト上で比較的速やかに行えます。

では、はじめましょう

StrikeIron のアカウントを » 取得 して » Super Data Pack にも参加したら、Zend_Service_StrikeIron を使うための準備は完了です。

StrikeIron には何百ものさまざまなウェブサービスが存在します。 Zend_Service_StrikeIron はこれらのサービスの多くで利用可能ですが、 特に以下の 3 つについてはラッパークラスを用意しています。

Zend_Service_StrikeIron クラスには、 そのコンストラクタで StrikeIron アカウント情報やその他のオプションを設定することができます。 また、StrikeIron の各種サービス用のクライアントを帰すファクトリメソッドも用意しています。

 'あなたのユーザ名',
                                                'password' => 'あなたのパスワード'));

$taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));

getService() メソッドは、StrikeIron のサービス用のクライアントを帰します。引数には PHP のラッパークラスの名前を指定します。 この場合の SalesUseTaxBasic は、ラッパークラス Zend_Service_StrikeIron_SalesUseTaxBasic を指しています。標準で組み込まれている 3 つのラッパーについては バンドルされているサービス で説明します。

getService() は、対応する PHP ラッパーを持たない StrikeIron サービス用のクライアントも返すことができます。 この機能については WSDL によるサービスの使用 で説明します。

はじめてのクエリ

getService() で StrikeIron サービス用のクライアントを取得したら、 あとは普通の PHP オブジェクトと同様にそのメソッドをコールすることができます。

 'あなたのユーザ名',
                                                'password' => 'あなたのパスワード'));

// Sales & Use Tax Basic サービス用のクライアントを取得します
$taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));

// カナダのオンタリオ州の税率を取得します
$rateInfo = $taxBasic->getTaxRateCanada(array('province' => 'ontario'));
echo $rateInfo->province;
echo $rateInfo->abbreviation;
echo $rateInfo->GST;
上の例では、getService() メソッドを使用して Sales & Use Tax Basic サービス用のクライアントを取得しています。 取得したオブジェクトは $taxBasic に保存します。

次に、そのサービスの getTaxRateCanada() メソッドをコールします。メソッドに対してキーワードパラメータを渡すには 連想配列を使用します。これは、すべての StrikeIron のメソッドで共通の方法です。

getTaxRateCanada() の返り値を $rateInfo に取得し、そのプロパティ provinceGST を参照しています。

StrikeIron のサービスの多くは、この例と同じくらい簡単に使用できます。 3 つの StrikeIron サービスについての詳細は バンドルされているサービス を参照ください。

結果の吟味

StrikeIron サービスについて学習したりデバッグしたりする際には、 メソッドから返された内容を出力できると便利です。 メソッドの返り値は常に Zend_Service_StrikeIron_Decorator のインスタンスとなります。 これはちょっとした » デコレータ オブジェクトであり、メソッドのコール結果をラップしています。

サービスが返した結果を調べる最も単純な方法は、 » print_r() のような PHP の組み込み関数を使うことです。

 'あなたのユーザ名',
                                                'password' => 'あなたのパスワード'));

$taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));

$rateInfo = $taxBasic->getTaxRateCanada(array('province' => 'ontario'));
print_r($rateInfo);
?>


Zend_Service_StrikeIron_Decorator Object
(
    [_name:protected] => GetTaxRateCanadaResult
    [_object:protected] => stdClass Object
        (
            [abbreviation] => ON
            [province] => ONTARIO
            [GST] => 0.06
            [PST] => 0.08
            [total] => 0.14
            [HST] => Y
        )
)

上の例でわかるように、デコレータ ($rateInfo) が GetTaxRateCanadaResult というオブジェクトをラップしています。 これが getTaxRateCanada() の返り値です。

この結果から、$rateInfo には abbreviationprovinceGST といった公開プロパティがあることがわかります。これらは $rateInfo->province のようにしてアクセスできます。

Tip

StrikeIron の結果のプロパティは、場合によっては大文字で始まっていることもあります (FooBar など)。一方、たいていの PHP オブジェクトのプロパティは、普通は小文字で始まる形式 (foobar など) です。このあたりはデコレータがうまく処理するので、 プロパティが Foo であっても foo として取得できるようになります。

もしデコレータではなく中身のオブジェクトそのものやその名前がほしい場合は、 それぞれ getDecoratedObject() および getDecoratedObjectName() を使用します。

エラー処理

先ほどの例はあまりにも無邪気すぎるところがありました。 エラー処理を一切していなかったのです。 メソッドをコールした際に、StrikeIron がエラーを返す可能性だってあります。 認証情報が間違っていたり、アカウントが有効期限切れになっていた場合などに StrikeIron はエラーを発します。

このような場合は例外がスローされます。 例外が発生することを想定して、 サービスのメソッドをコールする際には例外処理を書く必要があります。

 'あなたのユーザ名',
                                                'password' => 'あなたのパスワード'));

$taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));

try {

  $taxBasic->getTaxRateCanada(array('province' => 'ontario'));

} catch (Zend_Service_StrikeIron_Exception $e) {

  // 接続時のエラーなどの場合の
  // エラー処理をここで行います

}
スローされる例外は、常に Zend_Service_StrikeIron_Exception となります。

メソッドコール時の通常の失敗と例外の違いはしっかり把握しておきましょう。 例外が発生するのは、例外的な 状態です。たとえばネットワークの障害が発生したとか アカウントが有効期限切れになっていたとかいった状況がそれにあたります。 通常の失敗とは、もっと頻繁に起こりえるものです。 たとえば getTaxRateCanada() で指定した province が見つけられないときなどは例外とはなりません。

Note:

StrikeIron サービスのメソッドをコールする際には 常に返り値をチェックするようにしましょう。 もちろん例外処理も必要です。

購入内容の確認

StrikeIron にはさまざまなサービスがあります。 その中には無料で使えるものもあればお試し版のものもあります。 また、有料サービスのみのものもあります。 StrikeIron を使用するにあたっては、 そのサービスの購入状況を常に確認することが必要です。

getService メソッドが返す StrikeIron クライアントにはすべて、 そのサービスの購入状況を調べる getSubscriptionInfo() メソッドが存在します。

 'あなたのユーザ名',
                                                'password' => 'あなたのパスワード'));

$taxBasic = $strikeIron->getService(array('class => 'SalesUseTaxBasic'));

// Sales & Use Tax Basic サービスをあと何回使用できるかを調べます
$subscription = $taxBasic->getSubscriptionInfo();
echo $subscription->remainingHits;

getSubscriptionInfo() メソッドが返すオブジェクトの多くには、 remainingHits プロパティが含まれます。 これを調べて、使用しているサービスの状態を確認します。 残りの使用回数を超える数のメソッドコールを行うと、 StrikeIron は例外をスローします。

サービスの購入状況を調べる問い合わせを送っても、 残りの使用可能回数は減りません。 サービスのメソッドをコールする際にはいつも残りの回数を自動的に取得します。 この値は、サービスに接続しなくても getSubscriptionInfo() で取得することができます。 キャッシュを使用せずにもう一度情報を問い合わせるよう getSubscriptionInfo() に指示するには、 getSubscriptionInfo(true) とします。

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 ファイルの書式
命名規約
コーディングスタイル
著作権に関する情報