[wsf-c-dev] svn commit r713 - wsf/php/src/xdocs
svn at wso2.com
svn at wso2.com
Mon Feb 5 01:00:57 PST 2007
Author: marietta
Date: Mon Feb 5 01:00:52 2007
New Revision: 713
Modified:
wsf/php/src/xdocs/api_content.html
Log:
Made a minor change.
Modified: wsf/php/src/xdocs/api_content.html
==============================================================================
--- wsf/php/src/xdocs/api_content.html (original)
+++ wsf/php/src/xdocs/api_content.html Mon Feb 5 01:00:52 2007
@@ -5,23 +5,24 @@
<title></title>
<meta name="CREATED" content="20061009;17484000">
<meta name="CHANGED" content="20061011;10243100">
- <link href="style/api_style.css" rel="stylesheet" type="text/css" media="all" />
+ <link href="style/api_style.css" rel="stylesheet" type="text/css"
+ media="all">
</head>
<body lang="en-US" dir="ltr">
-<h1>WSO2 WSF for PHP API</h1>
-
-<p>WSO2 Web Services Framework for PHP is a PHP extension that could be used
-to provide and consume Web services. This document covers the API of WSO2 WSF
-for PHP extension.</p>
+<h1>WSO2 WSF/PHP API</h1>
+<p>WSO2 Web Services Framework/PHP is a PHP extension that could be used to
+provide and consume Web services. This document covers the API of WSO2
+WSF/PHP extension.</p>
<a id="pre"></a>
-<h2><b>Predefined Classes</b></h2>
+<h2><b>Predefined Classes</b></h2>
<a id="client"></a>
-<h2><b>WSClient</b></h2>
+<h2><b>WSClient</b></h2>
<a id="construct"></a>
+
<h3><b>Constructor</b></h3>
<a id="pre_WSClient"></a>
<ul>
@@ -172,8 +173,8 @@
<p><br>
<br>
</p>
-
<a id="method"></a>
+
<h3><b>Methods</b></h3>
<a id="pre_WSMessage"></a>
<ul>
@@ -300,27 +301,25 @@
None
<h3><b>Example</b></h3>
-<pre>
-<span style="color: rgb(0, 0, 255);">$reqPayloadString</span> = <<<XML
- <ns1:echoString xmlns:ns1=<span style="color: rgb(255, 0, 0);">"http://php.axis2.org/samples"</span>>
- <text>Hello World!</text>
- </ns1:echoString>
+<pre><span style="color: rgb(0, 0, 255);">$reqPayloadString</span> = <<<XML
+ <ns1:echoString xmlns:ns1=<span style="color: rgb(255, 0, 0);">"http://php.axis2.org/samples"</span>>
+ <text>Hello World!</text>
+ </ns1:echoString>
XML;
<span style="color: rgb(0, 0, 255);">$client</span> = <span style="color: rgb(0, 0, 0); font-weight: bold;">new</span> WSClient<span style="color: rgb(102, 204, 102);">(</span>
<a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"to"</span>=><span style="color: rgb(255, 0, 0);">"http://localhost/echo_service.php"</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;
-
+
<span style="color: rgb(0, 0, 255);">$resMessage</span> = <span style="color: rgb(0, 0, 255);">$client</span>-><span style="color: rgb(0, 102, 0);">request</span><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$reqPayloadString</span><span style="color: rgb(102, 204, 102);">)</span>;
- <a href="http://www.php.net/printf"><span style="color: rgb(0, 0, 102);">printf</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"Response = %s <br>"</span>, <a href="http://www.php.net/htmlspecialchars"><span style="color: rgb(0, 0, 102);">htmlspecialchars</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$resMessage</span>-><span style="color: rgb(0, 102, 0);">str</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;
-</pre>
+ <a href="http://www.php.net/printf"><span style="color: rgb(0, 0, 102);">printf</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"Response = %s <br>"</span>, <a href="http://www.php.net/htmlspecialchars"><span style="color: rgb(0, 0, 102);">htmlspecialchars</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$resMessage</span>-><span style="color: rgb(0, 102, 0);">str</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;</pre>
<p></p>
-
<a id="service"></a>
-<h2><b>WSService</b></h2>
+<h2><b>WSService</b></h2>
<a id="construct1"></a>
+
<h3><b>Constructor</b></h3>
<a id="service_WSService"></a>
<ul>
@@ -487,8 +486,8 @@
<p><br>
<br>
</p>
-
<a id="method1"></a>
+
<h3><b>Methods</b></h3>
<a id="service_void_WSService"></a>
<ul>
@@ -511,31 +510,30 @@
<h3><b>Member Variables</b></h3>
None <br>
+
<h3><b>Example</b></h3>
-<pre>
-<span style="color: rgb(0, 0, 0); font-weight: bold;">function</span> echoFunction<span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$inMessage</span><span style="color: rgb(102, 204, 102);">)</span> <span style="color: rgb(102, 204, 102);">{</span>
-
+<pre><span style="color: rgb(0, 0, 0); font-weight: bold;">function</span> echoFunction<span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$inMessage</span><span style="color: rgb(102, 204, 102);">)</span> <span style="color: rgb(102, 204, 102);">{</span>
+
<span style="color: rgb(0, 0, 255);">$returnMessage</span> = <span style="color: rgb(0, 0, 0); font-weight: bold;">new</span> WSMessage<span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$inMessage</span>-><span style="color: rgb(0, 102, 0);">str</span><span style="color: rgb(102, 204, 102);">)</span>;
-
+
<span style="color: rgb(177, 177, 0);">return</span> <span style="color: rgb(0, 0, 255);">$returnMessage</span>;
<span style="color: rgb(102, 204, 102);">}</span>
-
+
<span style="color: rgb(0, 0, 255);">$operations</span> = <a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"echoString"</span> => <span style="color: rgb(255, 0, 0);">"echoFunction"</span><span style="color: rgb(102, 204, 102);">)</span>;
-
+
<span style="color: rgb(0, 0, 255);">$svr</span> = <span style="color: rgb(0, 0, 0); font-weight: bold;">new</span> WSService<span style="color: rgb(102, 204, 102);">(</span><a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"operations"</span> => <span style="color: rgb(0, 0, 255);">$operations</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;
-<span style="color: rgb(0, 0, 255);">$svr</span>-><span style="color: rgb(0, 102, 0);">reply</span><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(102, 204, 102);">)</span>;
-</pre>
-<p></p>
+<span style="color: rgb(0, 0, 255);">$svr</span>-><span style="color: rgb(0, 102, 0);">reply</span><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(102, 204, 102);">)</span>;</pre>
+<p></p>
<a id="message"></a>
+
<h2><b>WSMessage</b></h2>
WSMessage class represents a message passed between a client and a service.
This class encapsulates the XML payload in various formats, WS-Addressing
action information related to the message, MTOM attachment data and other
-properties related to a message.
+properties related to a message. <a id="construct3"></a>
-<a id="construct3"></a>
<h3><b>Constructor</b></h3>
<a id="message_WSMessage"></a>
<ul>
@@ -787,14 +785,14 @@
<p><br>
<br>
</p>
-
<a id="method3"></a>
+
<h3><b>Methods</b></h3>
<p>None</p>
<a id="WSMessage_Member_ariables"></a>
-<h3><b>Member Variables</b></h3>
+<h3><b>Member Variables</b></h3>
<ul>
<li><p><b>string to</b></p>
</li>
@@ -913,12 +911,13 @@
in the <XOP:Include> element, and $image contains the string
representation of the binary content to be sent or being received.</p>
<br>
+
+
<h3><b>Example</b></h3>
-<pre>
-<span style="color: rgb(0, 0, 255);">$reqPayloadString</span> = <<<XML
- <ns1:<a href="http://www.php.net/echo"><span style="color: rgb(0, 0, 102);">echo</span></a> xmlns:ns1=<span style="color: rgb(255, 0, 0);">"http://php.axis2.org/samples"</span>>
- <text>Hello World!</text>
- </ns1:echo>
+<pre><span style="color: rgb(0, 0, 255);">$reqPayloadString</span> = <<<XML
+ <ns1:<a href="http://www.php.net/echo"><span style="color: rgb(0, 0, 102);">echo</span></a> xmlns:ns1=<span style="color: rgb(255, 0, 0);">"http://php.axis2.org/samples"</span>>
+ <text>Hello World!</text>
+ </ns1:echo>
XML;
<span style="color: rgb(0, 0, 255);">$reqMessage</span> = <span style="color: rgb(0, 0, 0); font-weight: bold;">new</span> WSMessage<span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$reqPayloadString</span>,
@@ -926,17 +925,17 @@
<span style="color: rgb(255, 0, 0);">"action"</span> => <span style="color: rgb(255, 0, 0);">"http://php.axis2.org/samples/echoString"</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;
<span style="color: rgb(0, 0, 255);">$client</span> = <span style="color: rgb(0, 0, 0); font-weight: bold;">new</span> WSClient<span style="color: rgb(102, 204, 102);">(</span><a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"useWSA"</span> => <span style="color: rgb(0, 0, 0); font-weight: bold;">TRUE</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;
-
+
<span style="color: rgb(0, 0, 255);">$resMessage</span> = <span style="color: rgb(0, 0, 255);">$client</span>-><span style="color: rgb(0, 102, 0);">request</span><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$reqMessage</span><span style="color: rgb(102, 204, 102);">)</span>;
<a href="http://www.php.net/printf"><span style="color: rgb(0, 0, 102);">printf</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"Response = %s <span style="color: rgb(0, 0, 153); font-weight: bold;">\n</span>"</span>, <span style="color: rgb(0, 0, 255);">$resMessage</span>-><span style="color: rgb(0, 102, 0);">str</span><span style="color: rgb(102, 204, 102);">)</span>;
-
+
</pre>
-
<a id="fault"></a>
-<h2><b>WSFault</b></h2>
+<h2><b>WSFault</b></h2>
<a id="construct2"></a>
+
<h3><b>Constructor</b></h3>
<a id="fault_WSFault"></a>
<ul>
@@ -1027,14 +1026,15 @@
<p><br>
<br>
</p>
-
<a id="method2"></a>
+
<h3><b>Methods</b></h3>
None
<p><br>
</p>
<a id="member_variables"></a>
+
<h3><b>Member Variables</b></h3>
<ul>
<li><p><b>string code</b></p>
@@ -1065,13 +1065,12 @@
<p><br>
</p>
<br>
-
-
<a id="function"></a>
+
<h2><b>Predefined Functions</b></h2>
<ul>
- <li><h4><a id="ws_request"></a><b>WSMessage ws_request (string payload |SimpleXMLElement payload |
- domDocument payload | WSMessage payload <br>
+ <li><h4><a id="ws_request"></a><b>WSMessage ws_request (string payload
+ |SimpleXMLElement payload | domDocument payload | WSMessage payload <br>
[, array options])</b></h4>
</li>
</ul>
@@ -1136,6 +1135,8 @@
<p>Throws WSFault on error.</p>
<br>
+
+
<p>Example</p>
<pre><span style="color: rgb(0, 0, 255);">$reqPayloadString</span> = <<<XML
<ns1:echoString xmlns:ns1=<span style="color: rgb(255, 0, 0);">"http://php.wsf.wso2.net/samples"</span>>
@@ -1147,12 +1148,11 @@
<a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"to"</span>=><span style="color: rgb(255, 0, 0);">"http://localhost/echo_service.php"</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;
<a href="http://www.php.net/printf"><span style="color: rgb(0, 0, 102);">printf</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"Response = %s <br>"</span>, <a href="http://www.php.net/htmlspecialchars"><span style="color: rgb(0, 0, 102);">htmlspecialchars</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$resMessage</span>-><span style="color: rgb(0, 102, 0);">str</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;</pre>
-
<br>
<ul>
- <li><h4><a id="ws_send"></a><b>void ws_send (string payload |SimpleXMLElement payload |
- domDocument payload | WSMessage payload <br>
+ <li><h4><a id="ws_send"></a><b>void ws_send (string payload
+ |SimpleXMLElement payload | domDocument payload | WSMessage payload <br>
[, array options])</b></h4>
</li>
</ul>
@@ -1218,6 +1218,8 @@
<p>Throws WSFault on error.</p>
<br>
+
+
<p>Example</p>
<pre><span style="color: rgb(0, 0, 255);">$reqPayloadString</span> = <<<XML
<ns1:notifyString xmlns:ns1=<span style="color: rgb(255, 0, 0);">"http://php.wsf.wso2.net/samples"</span>>
@@ -1227,8 +1229,6 @@
ws_send<span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$reqPayloadString</span>,
<a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"to"</span>=><span style="color: rgb(255, 0, 0);">"http://localhost/reply_notify_service.php"</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;</pre>
-
-
<br>
<ul>
@@ -1273,18 +1273,18 @@
<p>void</p>
<p>Throws WSFault on error.</p>
-<br/>
+<br>
+
+
<p>Example</p>
<pre><span style="color: rgb(0, 0, 0); font-weight: bold;">function</span> echoFunction<span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$inMessage</span><span style="color: rgb(102, 204, 102);">)</span> <span style="color: rgb(102, 204, 102);">{</span>
<span style="color: rgb(0, 0, 255);">$returnMessage</span> = <span style="color: rgb(0, 0, 0); font-weight: bold;">new</span> WSMessage<span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(0, 0, 255);">$inMessage</span>-><span style="color: rgb(0, 102, 0);">str</span><span style="color: rgb(102, 204, 102);">)</span>;
<span style="color: rgb(177, 177, 0);">return</span> <span style="color: rgb(0, 0, 255);">$returnMessage</span>;
<span style="color: rgb(102, 204, 102);">}</span>
-ws_reply<span style="color: rgb(102, 204, 102);">(</span><a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"operations"</span> => <a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"echoString"</span> => <span style="color: rgb(255, 0, 0);">"echoFunction"</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;
-</pre>
+ws_reply<span style="color: rgb(102, 204, 102);">(</span><a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"operations"</span> => <a href="http://www.php.net/array"><span style="color: rgb(0, 0, 102);">array</span></a><span style="color: rgb(102, 204, 102);">(</span><span style="color: rgb(255, 0, 0);">"echoString"</span> => <span style="color: rgb(255, 0, 0);">"echoFunction"</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span><span style="color: rgb(102, 204, 102);">)</span>;</pre>
-<p>
-<br/>
+<p><br>
</p>
</body>
</html>
More information about the Wsf-c-dev
mailing list