SOAP拡張モジュールは、 SOAPサーバーおよびクライアントを書くために使用することができます。 本拡張モジュールは、SOAP 1.1、 SOAP 1.2 および WSDL 1.1 規約のサブセットをサポートします。
本拡張モジュールは、 GNOME xml library を必要とします。 このライブラリをダウンロード／インストールしてください。 libxml-2.5.4 以上が必要です。
本拡張モジュールは、 --enable-soapを指定して PHPのconfigureが行われた場合のみ利用可能です。
php.ini の設定により動作が変化します。
表 1. SOAP 設定オプション
| 名前 | デフォルト | 変更の可否 | 変更履歴 |
|---|---|---|---|
| soap.wsdl_cache_enabled | "1" | PHP_INI_ALL | PHP 5.0.0 から利用可能 |
| soap.wsdl_cache_dir | "/tmp" | PHP_INI_ALL | PHP 5.0.0 から利用可能 |
| soap.wsdl_cache_ttl | "86400" | PHP_INI_ALL | PHP 5.0.0 から利用可能 |
以下に設定ディレクティブに関する 簡単な説明を示します。
SoapClient->__construct() - constructs a new SoapClient object
SoapClient->__call() - SOAP 関数をコールする (推奨されません)
SoapClient->__doRequest() - SOAP リクエストを実行する
SoapClient->__getFunctions() - SOAP 関数の一覧を返す
SoapClient->__getLastRequest() - 直近の SOAP リクエストを返す
SoapClient->__getLastRequestHeaders() - 直近の SOAP リクエストヘッダを返す
SoapClient->__getLastResponse() - 直近の SOAP レスポンスを返す
SoapClient->__getLastResponseHeaders() - 直近の SOAP レスポンスヘッダを返す
SoapClient->__getTypes() - SOAP 型の一覧を返す
SoapClient->__setCookie() - SOAP リクエストと共に送信されるクッキーを設定する
SoapClient->__soapCall() - SOAP 関数をコールする
SoapFault->__construct() - 新規 SoapFault オブジェクトを生成する
SoapHeader は、SOAP ヘッダを渡すもしくは返すための特別な低レベルクラスです。 このクラスは単純なデータホルダーで、 コンストラクタ以外の特別なメソッドを持ちません。このクラスは SOAP ヘッダを渡すための SoapClient->__soapCall() 中、もしくは SOAP レスポンスにおけるヘッダを返すための SOAP ヘッダハンドラ中で使用されます。
SoapHeader->__construct() - 新規 SoapHeader オブジェクトを生成する
SoapParam は、非 WSDL モードにおけるパラメータの名前付け、 もしくは値を返すための特別な低レベルクラスです。 このクラスは単純なデータホルダーで、 コンストラクタ以外の特別なメソッドを持ちません。
SoapParam->__construct() - 新規 SoapParam オブジェクトを生成する
SoapServer->__construct() - 新規 SoapServer オブジェクトを生成する
SoapServer->addFunction() - SOAP リクエストによって処理される単一もしくはいくつかの関数を追加する
SoapServer->getFunctions() - 定義されている関数の一覧を返す
SoapServer->handle() - SOAP リクエストを処理する
SoapServer->setClass() - SOAP リクエストを処理するクラスを設定する
SoapServer->setPersistence() - SoapServer の持続モードを設定する
SoapVar は、非 WSDL モードにおけるパラメータのエンコード、 もしくは値を返すための特別な低レベルクラスです。 このクラスは単純なデータホルダーで、 コンストラクタ以外の特別なメソッドを持ちません。 このクラスは SOAP リクエストもしくはレスポンスにおける型プロパティを 設定したい場合に有効です。
SoapVar->__construct() - 新規 SoapVar オブジェクトを生成する
以下の定数が定義されています。 この関数の拡張モジュールが PHP 組み込みでコンパイルされているか、 実行時に動的にロードされている場合のみ使用可能です。
PHP 5.1.0 で追加されました。