phpsoap.inc ver 0.7.12   関数一覧   2020年04月26日
この色
外部で使用可な関数(PHPSOAPクラスの関数)
この色
ユーティリティ関数(PHPSOAPクラスの関数では無い)
この色
内部で使用するサブ関数(PHPSOAPクラスの関数)
戻り値 関数名 パラメーター

PHPSOAP
(int server)

コンストラクタ
server=0:クライアント側オブジェクト作成
server=1:サーバー側オブジェクト作成
例 $soap = new PHPSOAP(0);
戻り値 関数名 パラメーター
String
get_encode
(String msg)

msgのXML宣言部からencodingの値を返します。
XML宣言がない場合は""を返します。
Shift-JISの場合はSJISを返します。
例 $encoding = $soap->get_encode($msg);
戻り値 関数名 パラメーター
String
server_error
(int err_code,String faultstring,String msg)

エラーメッセージをクライアントに返します。
err_code=0:VersionMismatch エラー
err_code=1:MustUnderstand エラー
err_code=2:Client エラー
err_code=3:Server エラー
msgはdetail要素の値(または子要素)として返されます。
msg=""の場合はdetail要素は追加しません。
msgをdetail要素の子要素とする場合はDOMツリーを作成して
encodeでテキストに変換したものをmsgにします
例 $soap->server_error(2,"client error","パラメータが異常です。");
戻り値 関数名 パラメーター

error_mode
(int mode,string error_func)

mode:1でエラー表示
mode:0でエラー非表示
mode:2でエラー非表示で処理関数error_funcを実行
error_funcの引数は(String error_msg)のみ
デフォルトはmode:0
例 $soap->error_mode(0,"");
  $soap->error_mode(2,"error_check");
戻り値 関数名 パラメーター

soap_die
(String msg)

msgを表示して終了します。
サーバー側オブジェクトの場合は
server_error(2,"client error",$msg)を実行します
例 $soap->soap_die("エラー");
戻り値 関数名 パラメーター
int(id)
make_Envelope
()

エンベロープノードを作成します。
例 $enve = $soap->make_Envelope();
戻り値 関数名 パラメーター
int(id)
make_Header
()

エンベロープヘッダーノードを作成します。
例 $head = $soap->make_Header();
戻り値 関数名 パラメーター
int(id)
make_Body
()

エンベロープボディノードを作成します。
例 $body = $soap->make_Body();
戻り値 関数名 パラメーター
string
encode
(int Node_id ,int flg)

Node_id(ルート=0)以下のNodeをxmlに変換しバッファmessに追加する。
xml宣言無し。
バッファmessの値を返す。
改行コードは\r\n。
flg=1:メッセージを整形する。
flg=0:メッセージを整形しない。
例 $soap->encode($enve,0);
戻り値 関数名 パラメーター
int(fp)
send_Message
(String DOMAIN,string path,String HOST,int port,String soapaction)

DOMAINのpathへ送信ホストがHOSTとしてメッセージを送信する。
port:通信に使用するポート番号。通常80番。
soapaction:ヘッダーにつけるSOAPACTION(デフォルト:"")
ファイルポインタを返します。
例 $fp = $soap->send_Message("localhost","/saver.php","localhost",80,"");
戻り値 関数名 パラメーター
String
get_message
(int fp)

ファイルポインタfpのサーバー側からのメッセージを取り込みます。
例 $msg = $soap->get_message($fp);
戻り値 関数名 パラメーター
int(id)
get_body
(String msg)

エンベロープボディノードのNode_idを取得します。
例 $body = $soap->get_body($msg);
戻り値 関数名 パラメーター
String
saver_get_message
()

クライアント側からのメッセージを取り込みます。
例 $msg = $soap->saver_get_message();
戻り値 関数名 パラメーター
String
get_function
(int body)

クライアント側から受信したメッセージからサービス名を取得します。
bodyはget_bodyの返り値。
例 $body = $soap->get_function($body);
戻り値 関数名 パラメーター
Array
get_param
(int body)

クライアント側から受信したメッセージからサービス用パラメータを連想配列に取得します。
bodyはget_bodyの返り値。
例 $param = $soap->get_param($body);
$param["name"][$i]が要素名。
$param["value"][$i]が要素の値。
戻り値 関数名 パラメーター

response
(Array param,String function,String NS,String URI)

メッセージをクライアント側に返信します。
param,functionに従いエンベロープを作成した後にメッセージを返信します。
param:サービスの返信パラメータの連想配列。
function:サービス名。
URI:ネームスペース用URI。
例 $answer["return"]=10;
  $function="ADD";
  $URI="http://www.test.com";
  $NS="rp";
  $fp = $soap->response($answer,$function,$NS,$URI);
戻り値 関数名 パラメーター
int(id)
make_form
()

soapのbodyまでのフォームを作成します。
bodyのidをを返します。
例 $soap->make_form();
戻り値 関数名 パラメーター
String
sever_return_message
()

クライアントにDOM処理後のsoapメッセージを返信します。
例 $body = $soap->make_form();
  DOM処理
  $soap->sever_return_message();
戻り値 関数名 パラメーター

response_type
(Array param,String function,String NS,String URI)

メッセージをクライアント側に返信します。
param,functionに従いエンベロープを作成した後にメッセージを返信します。
param:サービスの返信パラメータの連想配列。
$param["type"][$i]に返信パラメータの型(http://www.w3.org/1999/XMLSchemaの型int,Stringなど)
を指定することができます。
typeにSOAP-ENC:base64を指定するとBase64エンコードします。
この際set_encでセットしたエンコードを使用します。
set_encを使用しない場合はUTF-8を使用します。
function:サービス名。
URI:ネームスペース用URI。
例 $answer["name"][0]="return";
  $answer["value"][0]=10;
  $answer["type"][0]="int";
  $function="ADD";
  $URI="http://www.test.com";
  $NS="rp";
  $fp = $soap->response_type($answer,$function,$NS,$URI);
戻り値 関数名 パラメーター
String
get_enc
()

get_param関数でBase64エンコードを復元した文字列のエンコードを返します。
Base64エンコードがない場合はUTF-8を返します。
例 $soap->get_enc();
戻り値 関数名 パラメーター
String
set_enc
(String encode)

response_typeでBase64エンコードをするときの文字列のエンコードをセットします。
デフォルトではUTF-8になっています。
例 $soap->enc_enc("sjis");
戻り値 関数名 パラメーター
String
get_comment
()

全てのコメントを結合したものを返します。
例 $soap->get_comment();
戻り値 関数名 パラメーター
String
get_pi
()

全てのPIを結合したものを返します。
それぞれのPIは下のような構造になっております。
<?target
data
?>
例 $soap->get_pi();
戻り値 関数名 パラメーター
String
get_xml
()

XML宣言を返します。
例 $soap->get_xml();
戻り値 関数名 パラメーター
String
get_dtd
()

DTDのブロック全てを返します。
例 $soap->get_dtd();
戻り値 関数名 パラメーター

add_attrib
(int Node_id,string attrib)

Node_idのNodeにattribを解析して属性を加える。
attribは半角スペース1つで区切って列挙する。
属性値は{"}または{'}で囲う。
例 $soap->add_attrib($id,"no='3' name='test'");
戻り値 関数名 パラメーター
int(id)
make_node
(int parent_id,string node_name,string attrib,string ns)

新しいNodeを作成し、そのNode_idを返す。
戻り値 関数名 パラメーター
int(id)
make_textnode
(int parent_id,string value)

新しいテキストNodeを作成し、そのNode_idを返す。
戻り値 関数名 パラメーター
int(id)
make_root
(string node_name,string ns)

ルートNodeを作成し、そのNode_idを返す。
戻り値 関数名 パラメーター

add_child
(int Node_id,int child_id)

Node_idの子NodeとしてNode_id(child_id)のNodeを加える。
戻り値 関数名 パラメーター

insert_child
(int Node_id,int child_id,int index)

Node_idの子Nodeとしてchild_idのNodeをindex番目に加える。
Node_idのindex番目以降の子Nodeはそれぞれ位置が1つずつシフトする。
戻り値 関数名 パラメーター
int(id)
add_textnode
(int parent_id,string value)

テキストNodeを作成してparent_idのNodeの子Nodeとして追加する。
 $id = $soap->make_textnode($parent_id,$value);
 $soap->add_child($parent_id,$id); と同じ。
戻り値 関数名 パラメーター
int(id)
add_node
(int parent_id,string node_name,string attrib,string ns)

Nodeを作成してparent_idのNodeの子Nodeとして追加する。
 $id = $soap->make_node($parent_id,$node_name,$attrib,$ns);
 $soap->add_child($parent_id,$id); と同じ。
戻り値 関数名 パラメーター
int(id)
insert_textnode
(int parent_id,int index,string text)

テキストNodeを作成してparent_idのNodeの子Nodeのindex番目に挿入する。
 $id = $soap->make_textnode($parent_id,$text);
 $soap->insert_child($parent_id,$id,$index); と同じ。
戻り値 関数名 パラメーター
int(id)
insert_node
(int parent_id,int index,string node_name,string attrib,string ns)

Nodeを作成してparent_idのNodeの子Nodeのindex番目に挿入する。
 $id = $soap->make_node($parent_id,$node_name,$attrib,$ns);
 $soap->insert_child($parent_id,$id,$index); と同じ。
戻り値 関数名 パラメーター
string(ns)
split_NS
(string* name)

nameをネームスペースと要素名に分解する。
nsにネームスペースを返す。
引数nameに要素名を返す(参照呼出し)。
戻り値 関数名 パラメーター

piblock
(string pi)

sax処理。piを解読してxml宣言部と処理命令部に分解する。
戻り値 関数名 パラメーター

dtdblock
(string dtd)

sax処理。dtdを解読して実体宣言部を配列に展開する。
戻り値 関数名 パラメーター

commentblock
(string comment)

sax処理。commentをコメントバッファに代入する。
戻り値 関数名 パラメーター

characters
(string text,int flg)

sax処理。textを解読してテキストノードに展開する。
戻り値 関数名 パラメーター

startDocument
()

sax処理。ドキュメントの開始処理。
戻り値 関数名 パラメーター

endDocument
()

sax処理。ドキュメントの終了処理。
戻り値 関数名 パラメーター

startElement
(string ns,string name,string attrib)

sax処理。要素の開始部。ノードを作成する。
戻り値 関数名 パラメーター

endElement
(string ns,string name)

sax処理。要素の終了部。テキストノードを作成する。
戻り値 関数名 パラメーター

textcheck
(string text)

sax処理。textを解読して各処理関数を呼び出す。
戻り値 関数名 パラメーター

blockcheck
(string block)

sax処理。blockを解読してバッファにデータを振り分ける。
戻り値 関数名 パラメーター

saxparser
(string text)

sax処理。textをsax処理してノードツリーに展開する。
戻り値 関数名 パラメーター

file2node
(string filename)

failnameのxmlファイルをNodeツリーに変換する。
戻り値 関数名 パラメーター
Boolean
is_text
(int Node_id)

Node_idがテキストNodeの場合trueその他の場合falseを返す。
戻り値 関数名 パラメーター
String
get_text
(int Node_id)

Node_idのテキストNodeの値を返す。
戻り値 関数名 パラメーター
String
get_value
(int Node_id)

Node_idの子テキストNodeの値を結合して返す。
戻り値 関数名 パラメーター
String
get_child_value
(int Node_id,string node_name)

子Node(node_name)の子テキストNodeの値を結合して返す。
戻り値 関数名 パラメーター
String
get_child_value_ns
(int Node_id,string node_name,string ns)

子Node(ns:node_name)の子テキストNodeの値を結合して返す。
戻り値 関数名 パラメーター
String
get_node_name
(int Node_id)

Node(Node_id)のタグ名を返す。
戻り値 関数名 パラメーター
String
get_ns
(int Node_id)

Node(Node_id)のネームスペースを返す。
戻り値 関数名 パラメーター
String
get_uri
(string ns,int id)

ノード番号idのネームスペース(ns)のURIを返す。
デフォルトのネームスペースは""を指定する。
設定されていないネームスペースには""を返す。
戻り値 関数名 パラメーター
int(id)
get_parent
(int Node_id)

Node(Node_id)の親Nodeのidを返す。
戻り値 関数名 パラメーター
Boolean
del_child
(int Node_id,int child_id)

child_idのNode以下のノードツリーをNode_idから削除する。
削除OKの場合はtrue、NGの場合はfalseを返す。
削除後も直接child_idを指定すればアクセス可能。
戻り値 関数名 パラメーター
Boolean
del_child_node
(int Node_id,string child_name)

child_nameのNode以下ノードツリーをNode_idから削除する。
削除OKの場合はtrue、NGの場合はfalseを返す。
戻り値 関数名 パラメーター
Boolean
del_child_node_ns
(int Node_id,string child_name,string ns)

ns:child_nameのNode以下ノードツリーをNode_idから削除する。
削除OKの場合はtrue、NGの場合はfalseを返す。
戻り値 関数名 パラメーター
Boolean
del_attrib
(int Node_id,String attrib_name)

attrib_nameの属性をNode_idのノードから削除する。
削除OKの場合はtrue、NGの場合はfalseを返す。
戻り値 関数名 パラメーター
Boolean
del_node
(int Node_id)

Node_idのNode以下のすべてのNodeをNodeツリーから削除する。
削除OKの場合はtrue、NGの場合はfalseを返す。
削除後も直接Node_idを指定すればアクセス可能。
戻り値 関数名 パラメーター
int(id)
get_singlenode
(string path)

pathの指すNodeの配列の最初のNode_idを返す。
pathはルートからの絶対パスを指定する。
例 $id = $soap->get_singlenode("Root/node1/node2");
  この場合はRoot/node1以下のすべてのタグ名(node2)のNode_idの配列のうち
  最初のNode_idを返す。
  $node_array = $soap->get_node("Root/node1/node2");
  $id = $node_array[0]; と同じ。
戻り値 関数名 パラメーター
int(id)
get_singlenode_ns
(string path,string ns)

pathの指すNodeの配列の最初のNode_idを返す。
pathはルートからの絶対パスを指定する。
例 $id = $soap->get_singlenode_ns("Root/node1/node2","sss");
  この場合はRoot/node1以下のすべてのタグ名(sss:node2)のNode_idの配列のうち
  最初のNode_idを返す。
  $node_array = $soap->get_node_ns("Root/node1/node2","sss");
  $id = $node_array[0]; と同じ。
戻り値 関数名 パラメーター
int(id)
get_singlenode_nsa
(string path)

pathの指すNodeの配列の最初のNode_idを返す。
pathはルートからの絶対パスを指定する。
pathのすべての部分にネームスペースを指定する。
例 $id = $soap->get_singlenode_nsa("a:Root/b:node1/c:node2");
  この場合はa:Root/b:node1以下のすべてのタグ名(c:node2)のNode_idの
  配列のうち最初のNode_idを返す。
  $node_array = $soap->get_node_nsa("a:Root/b:node1/c:node2");
  $id = $node_array[0]; と同じ。
戻り値 関数名 パラメーター
Array(id)
get_node
(string path)

pathの指すNodeのNode_idの配列を返す。
pathはルートからの絶対パスを指定する。
例 $node_array = $soap->get_node("Root/node1/node2");
  この場合はRoot/node1以下のすべてのタグ名(node2)のNode_idの配列が
  $node_arrayに返る。
戻り値 関数名 パラメーター
Array(id)
get_node_ns
(string path,string ns)

pathの指すNodeのNode_idの配列を返す。
pathはルートからの絶対パスを指定する。
例 $node_array = $soap->get_node_ns("Root/node1/node2","sss");
  この場合はRoot/node1以下のすべてのタグ名(sss:node2)のNode_idの配列が
  $node_arrayに返る。
戻り値 関数名 パラメーター
Array(id)
get_node_nsa
(string path)

pathの指すNodeのNode_idの配列を返す。
pathはルートからの絶対パスを指定する。
pathのすべての部分にネームスペースを指定する。
例 $node_array = $soap->get_node_ns("a:Root/b:node1/c:node2");
  この場合はa:Root/b:node1以下のすべてのタグ名(c:node2)のNode_idの配列が
  $node_arrayに返る。
戻り値 関数名 パラメーター
int(id)
get_singlenode_r
(int Node_id,string path)

pathの指すNodeの配列の最初のNode_idを返す。
pathはNode_idのNodeからの相対パスを指定する。
例 $id = $soap->get_singlenode_r($id,"node1/node2");
  この場合は$idの指すNodeの子Nodeのうちnode1以下のすべてのタグ名(node2)の
  Node_idの配列のうち最初のNode_idを返す。
  $node_array = $soap->get_node_r($id,"node1/node2");
  $id = $node_array[0]; と同じ。
戻り値 関数名 パラメーター
int(id)
get_singlenode_r_ns
(int Node_id,string path,string ns)

pathの指すNodeの配列の最初のNode_idを返す。
pathはNode_idのNodeからの相対パスを指定する。
例 $id = $soap->get_singlenode_r_ns($id,"node1/node2","sss");
  この場合は$idの指すNodeの子Nodeのうちnode1以下のすべてのタグ名(sss:node2)の
  Node_idの配列のうち最初のNode_idを返す。
  $node_array = $soap->get_node_r_ns($id,"node1/node2","sss");
  $id = $node_array[0]; と同じ。
戻り値 関数名 パラメーター
int(id)
get_singlenode_r_nsa
(int Node_id,string path)

pathの指すNodeの配列の最初のNode_idを返す。
pathはNode_idのNodeからの相対パスを指定する。
pathのすべての部分にネームスペースを指定する。
例 $id = $soap->get_singlenode_r_nsa($id,"a:node1/b:node2");
  この場合は$idの指すNodeの子Nodeのうちa:node1以下のすべての
  タグ名(b:node2)のNode_idの配列のうち最初のNode_idを返す。
  $node_array = $soap->get_node_r_nsa($id,"a:node1/b:node2");
  $id = $node_array[0]; と同じ。
戻り値 関数名 パラメーター
Array(id)
get_node_r
(int Node_id,string path)

pathの指すNodeのNode_idの配列を返す。
pathはNode_idのNodeからの相対パスを指定する。
例 $node_array = $soap->get_node_r($id,"node1/node2");
  この場合は$idの指すNodeの子Nodeのうちnode1以下のすべてのタグ名(node2)の
  Node_idの配列が$node_arrayに返る。
戻り値 関数名 パラメーター
Array(id)
get_node_r_ns
(int Node_id,string path,string ns)

pathの指すNodeのNode_idの配列を返す。
pathはNode_idのNodeからの相対パスを指定する。
例 $node_array = $soap->get_node_r_ns($id,"node1/node2","sss");
  この場合は$idの指すNodeの子Nodeのうちnode1以下のすべてのタグ名(sss:node2)の
  Node_idの配列が$node_arrayに返る。
戻り値 関数名 パラメーター
Array(id)
get_node_r_nsa
(int Node_id,string path)

pathの指すNodeのNode_idの配列を返す。
pathはNode_idのNodeからの相対パスを指定する。
pathのすべての部分にネームスペースを指定する。
例 $node_array = $soap->get_node_r_ns($id,"a:node1/b:node2");
  この場合は$idの指すNodeの子Nodeのうちa:node1以下のすべての
  タグ名(b:node2)のNode_idの配列が$node_arrayに返る。
戻り値 関数名 パラメーター
Array(id)
get_child_node
(int Node_id,string node_name)

子Node(node_name)のidの配列を返す。
戻り値 関数名 パラメーター
Array(id)
get_child_node_ns
(int Node_id,string node_name,string ns)

子Node(ns:node_name)のidの配列を返す。
戻り値 関数名 パラメーター
Array(id)
get_childs
(int Node_id)

Node_idのNodeのすべての子Nodeのidの配列を返す。
戻り値 関数名 パラメーター
Array(id)
get_childs_ns
(int Node_id,string ns)

Node_idのNodeのすべての子NodeのうちネームスペースがnsのNodeのidの配列を返す。
戻り値 関数名 パラメーター
int(id)
get_root
()

ルートNodeのidを返す。
戻り値 関数名 パラメーター

set_value
(int Node_id,string value)

Node_idのNodeの子テキストNodeに値をセットする。
戻り値 関数名 パラメーター

set_text
(int Node_id,string value)

Node_idのテキストNodeに値をセットする。
戻り値 関数名 パラメーター
Boolean
set_attrib
(int Node_id,string attrib_name,string attrib_value)

Node_idのNodeの属性をセットする。
セットOkの場合はtrue、NGの場合はfalseを返す。
戻り値 関数名 パラメーター
String
get_attrib
(int Node_id,string attrib_name)

Node_idのNodeの属性(名前=attrib_name)を取得する。
取得NGの場合は""(ヌル)を返す。
戻り値 関数名 パラメーター

set_node_name
(int Node_id,string Node_name)

Node_idのタグ名をセットする。
戻り値 関数名 パラメーター

set_ns
(int Node_id,string ns)

Node_idのネームスペースをセットする。
戻り値 関数名 パラメーター

set_uri
(string ns,string uri)

ネームスペースnsのURIをセットする。
戻り値 関数名 パラメーター
int(id)
copy_node
(int Node_id)

Node_id以下のノードをコピーする。
戻り値 関数名 パラメーター

write_attrib
(int Node_id)

Nodeのattributeをバッファmessに追加する。
戻り値 関数名 パラメーター

write_node_name
(int Node_id,int level)

Nodeのタグ(attributeを含む)をバッファmessに追加する。
戻り値 関数名 パラメーター

write_node_close
(int Node_id,int level)

Nodeの終了タグをバッファmessに追加する。
戻り値 関数名 パラメーター

write_node_value
(int Node_id)

Nodeのvalueをバッファmessに追加する。
戻り値 関数名 パラメーター

write_node_line
(int Node_id,int level)

Nodeの一行をバッファmessに追加する。
子テキストNodeがない場合。
戻り値 関数名 パラメーター

write_node_line2
(int Node_id,int level)

Nodeの一行をバッファmessに追加する。
子テキストNodeが1つの場合。
戻り値 関数名 パラメーター
string
write_node
(int Node_id,int fp,int flg,string enc)

fpが""以外の場合Node_id(ルート=0)以下のNodeをファイル(fp)に書き出す。
xml宣言付き。
ファイルに書き出すものと同じ内容を返す。
flg=1の場合は元のPI,DTDを出力する。
もとのxmlファイルにxml宣言がない場合はencをencodeにセットしたxml宣言を出力する。
改行コードは\n。
戻り値 関数名 パラメーター
string
dump_dom
(Obj soap)

domオブジェクトの内部配列を出力する。
例 $fp = fopen("dom1.inc","w");
  fwrite($fp,dump_dom($soap));
  fclose($fp);
戻り値 関数名 パラメーター

reverse_dom
(Obj soap)

dump_domで出力した配列をdomオブジェクトの内部配列に代入する。
例 require("dom1.inc");
  $soap = new SOAP(0);
  reverse_dom($soap);