- SOAP Configuration Options
+ SOAP &ConfigureOptions;
- Name
- Default
- Changeable
- Changelog
+ &Name;
+ &Default;
+ &Changeable;
+ &Changelog;
- soap.wsdl_cache_enabled
- "1"
+ soap.wsdl_cache_enabled
+ 1PHP_INI_ALL
- Available since PHP 5.0.0.
+
- soap.wsdl_cache_dir
- "/tmp"
+ soap.wsdl_cache_dir
+ /tmpPHP_INI_ALL
- Available since PHP 5.0.0.
+
- soap.wsdl_cache_ttl
- "86400"
+ soap.wsdl_cache_ttl
+ 86400PHP_INI_ALL
- Available since PHP 5.0.0.
+
- soap.wsdl_cache_limit
- "5"
+ soap.wsdl_cache
+ 1PHP_INI_ALL
- Available since PHP 5.1.5.
+
- soap.wsdl_cache
- "1"
+ soap.wsdl_cache_limit
+ 5PHP_INI_ALL
- Available since PHP 5.1.5.
+
-
+
- &ini.php.constants;
-
+
-&ini.descriptions.title;
+ &ini.descriptions.title;
-
-
-
-
- soap.wsdl_cache_enabled
- boolean
-
-
-
- Enables or disables the WSDL caching feature.
-
-
-
-
-
- soap.wsdl_cache_dir
- string
-
-
-
- Sets the directory name where the SOAP extension will put cache files.
-
-
-
-
-
- soap.wsdl_cache_ttl
- integer
-
-
-
- Sets the number of seconds (time to live) that cached files will be used
- instead of the originals.
-
-
-
-
-
- soap.wsdl_cache_limit
- integer
-
-
-
- Maximum number of in-memory cached WSDL files. Adding further files into
- a full memory cache will delete the oldest files from it.
-
-
-
-
-
- soap.wsdl_cache
- integer
-
-
-
- If soap.wsdl_cache_enabled is on, this setting
- determines the type of caching. It can be any of:
- WSDL_CACHE_NONE (0),
- WSDL_CACHE_DISK (1),
- WSDL_CACHE_MEMORY (2) or
- WSDL_CACHE_BOTH (3). This can
- also be set via the options array in the
- SoapClient or SoapServer
- constructor.
-
-
-
-
+
+
+
+
+ soap.wsdl_cache_enabled
+ integer
+
+
+
+ Enables or disables the WSDL caching feature.
+
+
+
+
+
+ soap.wsdl_cache_dir
+ string
+
+
+
+ Sets the directory name where the SOAP extension will put cache files.
+
+
+
+
+
+ soap.wsdl_cache_ttl
+ integer
+
+
+
+ Sets the number of seconds (time to live) that cached files will be used
+ instead of the originals.
+
+
+
+
+
+ soap.wsdl_cache
+ integer
+
+
+
+ If soap.wsdl_cache_enabled is on, this setting
+ determines the type of caching. It can be any of:
+ WSDL_CACHE_NONE (0),
+ WSDL_CACHE_DISK (1),
+ WSDL_CACHE_MEMORY (2) or
+ WSDL_CACHE_BOTH (3). This can
+ also be set via the options array in the
+ SoapClient or SoapServer
+ constructor.
+
+
+
+
+
+ soap.wsdl_cache_limit
+ integer
+
+
+
+ Maximum number of in-memory cached WSDL files. Adding further files into
+ a full memory cache will delete the oldest files from it.
+
+
+
+
+
-
-
-
diff --git a/reference/soap/reference.xml b/reference/soap/reference.xml
index 41de76a66d..38ffc14b8c 100644
--- a/reference/soap/reference.xml
+++ b/reference/soap/reference.xml
@@ -1,174 +1,13 @@
-
-
+
+
+
SOAP &Functions;
-
-
-
-
-
- &reftitle.classes;
-
-
- <classname>SoapClient</classname>
-
-
- &reftitle.constructor;
-
-
- -
- constructs a new SoapClient object
-
-
-
-
- &reftitle.methods;
-
-
- - Calls a SOAP function (deprecated)
-
-
- - Performs a SOAP request
-
-
- - Returns list of SOAP functions
-
-
- - Returns last SOAP request
-
-
- - Returns last SOAP request headers
-
-
- - Returns last SOAP response
-
-
- - Returns last SOAP response headers
-
-
- - Returns list of SOAP types
-
-
- - Sets the
- cookie that will be sent with the SOAP request
-
-
- - Calls a SOAP function
-
-
-
-
-
-
- <classname>SoapFault</classname>
-
-
- &reftitle.constructor;
-
-
- - construct a new SoapFault object
-
-
-
-
-
-
- <classname>SoapHeader</classname>
-
- SoapHeader is a special low-level class for passing
- or returning SOAP headers. It's just a data holder and it does not have any
- special methods except its constructor. It can be used in the method to pass a SOAP header or
- in a SOAP header handler to return the header in a SOAP response.
-
-
- &reftitle.constructor;
-
-
- - construct a new SoapHeader object
-
-
-
-
-
-
- <classname>SoapParam</classname>
-
- SoapParam is a special low-level class for naming
- parameters and returning values in non-WSDL mode.
- It's just a data holder and it does not have any special methods except
- its constructor.
-
-
- &reftitle.constructor;
-
-
- - construct a new SoapParam object
-
-
-
-
-
-
- <classname>SoapServer</classname>
-
-
- &reftitle.constructor;
-
-
- - construct a new SoapServer object
-
-
-
-
- &reftitle.methods;
-
-
- - Adds one or several functions those will handle SOAP requests
-
-
- -
-
-
- - Returns list of defined functions
-
-
- - Handles a SOAP request
-
-
- - Sets class which will handle SOAP requests
-
-
- - Sets persistence mode of SoapServer
-
-
-
-
-
-
- <classname>SoapVar</classname>
-
- SoapVar is a special low-level class for encoding
- parameters and returning values in non-WSDL mode. It's
- just a data holder and does not have any special methods except the constructor.
- It's useful when you want to set the type property in SOAP request or response.
-
-
- &reftitle.constructor;
-
-
- - construct a new SoapVar object
-
-
-
-
-
-
-
-
&reference.soap.entities.functions;
-
+
+
+
+
diff --git a/reference/soap/setup.xml b/reference/soap/setup.xml
index 97d4d2e451..5e0630b9c3 100644
--- a/reference/soap/setup.xml
+++ b/reference/soap/setup.xml
@@ -1,40 +1,38 @@
-
+
&reftitle.setup;
-
&reftitle.required;
+
This extension makes use of the GNOME xml
library. Download and install this library. You will need at
least libxml-2.5.4.
-
-
+
&reftitle.install;
This extension is only available if PHP was configured with
.
+
&reference.soap.ini;
-
&reftitle.resources;
- &no.resource;
+ &no.resource;
-
diff --git a/reference/soap/soapclient.xml b/reference/soap/soapclient.xml
new file mode 100644
index 0000000000..0b9fd57205
--- /dev/null
+++ b/reference/soap/soapclient.xml
@@ -0,0 +1,69 @@
+
+
+
+
+
+ The <classname>SoapClient</classname> class
+ SoapClient
+
+
+
+
+
+ &reftitle.intro;
+
+ The SoapClient class provides a client for SOAP 1.1, SOAP 1.2 servers. It can be used in WSDL
+ or non-WSDL mode.
+
+
+
+
+
+ &reftitle.classsynopsis;
+
+
+
+ SoapClient
+
+
+
+
+ SoapClient
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+
+ &reference.soap.entities.soapclient;
+
+
+
+
diff --git a/reference/soap/soapclient/call.xml b/reference/soap/soapclient/call.xml
new file mode 100644
index 0000000000..f783b5caf2
--- /dev/null
+++ b/reference/soap/soapclient/call.xml
@@ -0,0 +1,44 @@
+
+
+
+
+
+ SoapClient::__call
+ Calls a SOAP function (deprecated)
+
+
+
+ &reftitle.description;
+
+ publicvoidSoapClient::__call
+ stringfunction_name
+ stringarguments
+
+
+ This method is deprecated. Use instead of it.
+
+
+
+
+
+
diff --git a/reference/soap/soapclient/construct.xml b/reference/soap/soapclient/construct.xml
new file mode 100644
index 0000000000..6aad131272
--- /dev/null
+++ b/reference/soap/soapclient/construct.xml
@@ -0,0 +1,43 @@
+
+
+
+
+
+ SoapClient::__construct
+ SoapClient constructor
+
+
+
+ &reftitle.description;
+
+ SoapClient::SoapClient
+ mixedwsdl
+ arrayoptions
+
+
+ &info.function.alias; SoapClient::SoapClient
+
+
+
+
+
+
diff --git a/reference/soap/functions/soap-soapclient-dorequest.xml b/reference/soap/soapclient/dorequest.xml
similarity index 66%
rename from reference/soap/functions/soap-soapclient-dorequest.xml
rename to reference/soap/soapclient/dorequest.xml
index c17de0250a..85dd35bd4f 100644
--- a/reference/soap/functions/soap-soapclient-dorequest.xml
+++ b/reference/soap/soapclient/dorequest.xml
@@ -1,27 +1,22 @@
-
-
-
+
+
+
+
- SoapClient->__doRequest
-
- Performs a SOAP request
-
+ SoapClient::__doRequest
+ Performs a SOAP request
&reftitle.description;
-
- SoapClient
-
- string
- __doRequest
- stringrequest
- stringlocation
- stringaction
- intversion
- intone_way0
-
-
+
+ publicstringSoapClient::__doRequest
+ stringrequest
+ stringlocation
+ stringaction
+ intversion
+ intone_way0
+
Performs SOAP request over HTTP.
@@ -71,6 +66,8 @@
one_way
+ If one_way is set to 1, this method returns nothing.
+ Use this where a response is not expected.
@@ -85,35 +82,11 @@
-
- &reftitle.changelog;
-
-
-
-
-
- &Version;
- &Description;
-
-
-
-
- 5.1.3
-
- The one_way parameter was added.
-
-
-
-
-
-
-
-
&reftitle.examples;
- Some examples
+ <function>SoapClient::__doRequest</function> example
Add(3,4));
-
-
+
+
+
+
- SoapClient->__getFunctions
-
- Returns list of SOAP functions
-
+ SoapClient::__getFunctions
+ Returns list of available SOAP functions
+
&reftitle.description;
-
- SoapClient
-
- array
- __getFunctions
-
-
-
+
+ publicvoidSoapClient::__getFunctions
+
+
- Returns the list of SOAP functions.
+ Returns a list of available SOAP functions.
+
+
+ This function only works in WSDL mode.
-
-
- This function works only in WSDL mode.
-
-
+
+
+ &reftitle.parameters;
+ &no.function.parameters;
+
+
&reftitle.returnvalues;
The list of SOAP functions.
+
&reftitle.examples;
- SoapClient->__getFunctions() example
+ <function>SoapClient::__getFunctions</function> example
__getFunctions());
+
&reftitle.seealso;
-
+ SoapClient::SoapClient
+
-
+
+
+
+
- SoapClient->__getLastRequest
-
- Returns last SOAP request
-
+ SoapClient::__getLastRequest
+ Returns last SOAP request
+
&reftitle.description;
-
- SoapClient
-
- string
- __getLastRequest
-
-
-
+
+ publicstringSoapClient::__getLastRequest
+
+
+
+ Returns the XML sent in the last SOAP request.
+
This method works only if the SoapClient object
- was created with the trace option.
+ was created with the trace option set to true.
+
+
+ &reftitle.parameters;
+ &no.function.parameters;
+
+
&reftitle.returnvalues;
- The last SOAP request.
+ The last SOAP request, as an XML string.
+
&reftitle.examples;
@@ -47,17 +53,18 @@ echo "REQUEST:\n" . $client->__getLastRequest() . "\n";
+
&reftitle.seealso;
-
-
-
-
+ SoapClient::__getLastRequestHeaders
+ SoapClient::__getLastResponse
+ SoapClient::__getLastResponseHeaders
+
+
+
+
+ SoapClient::__getLastRequestHeaders
+ Returns the SOAP headers from the last request
+
+
+
+ &reftitle.description;
+
+ publicstringSoapClient::__getLastRequestHeaders
+
+
+
+ Returns the SOAP headers from the last request.
+
+
+
+ This function only works if the
+ SoapClient object was created with the trace
+ option set to true.
+
+
+
+
+
+ &reftitle.parameters;
+ &no.function.parameters;
+
+
+
+ &reftitle.returnvalues;
+
+ The last SOAP request headers.
+
+
+
+
+ &reftitle.examples;
+
+
+ SoapClient->__getLastRequest() example
+
+ 1));
+$result = $client->SomeFunction();
+echo "REQUEST HEADERS:\n" . $client->__getLastRequestHeaders() . "\n";
+?>
+]]>
+
+
+
+
+
+
+ &reftitle.seealso;
+
+
+ SoapClient::__getLastResponseHeaders
+ SoapClient::__getLastRequest
+ SoapClient::__getLastResponse
+
+
+
+
+
+
+
diff --git a/reference/soap/functions/soap-soapclient-getlastresponse.xml b/reference/soap/soapclient/getlastresponse.xml
similarity index 54%
rename from reference/soap/functions/soap-soapclient-getlastresponse.xml
rename to reference/soap/soapclient/getlastresponse.xml
index 8bc95d5e81..022aec37a7 100644
--- a/reference/soap/functions/soap-soapclient-getlastresponse.xml
+++ b/reference/soap/soapclient/getlastresponse.xml
@@ -1,35 +1,41 @@
-
-
-
+
+
+
+
- SoapClient->__getLastResponse
-
- Returns last SOAP response.
-
+ SoapClient::__getLastResponse
+ Returns last SOAP response
+
&reftitle.description;
-
- SoapClient
-
- string
- __getLastResponse
-
-
-
+
+ publicstringSoapClient::__getLastResponse
+
+
+
+ Returns the XML sent in the last SOAP response.
+
This method works only if the SoapClient object
- was created with the trace option.
+ was created with the trace option set to true.
+
+
+ &reftitle.parameters;
+ &no.function.parameters;
+
+
&reftitle.returnvalues;
- The last SOAP response.
+ The last SOAP response, as an XML string.
+
&reftitle.examples;
@@ -40,24 +46,25 @@
1));
$result = $client->SomeFunction();
-echo "RESPONSE:\n" . $client->__getLastResponse() . "\n";
+echo "REsponse:\n" . $client->__getLastResponse() . "\n";
?>
]]>
+
&reftitle.seealso;
-
-
-
-
+ SoapClient::__getLastResponseHeaders
+ SoapClient::__getLastRequest
+ SoapClient::__getLastRequestHeaders
+
+
+
+
+ SoapClient::__getLastResponseHeaders
+ Returns the SOAP headers from the last response
+
+
+
+ &reftitle.description;
+
+ publicstringSoapClient::__getLastResponseHeaders
+
+
+
+ Returns the SOAP headers from the last response.
+
+
+
+ This function only works if the
+ SoapClient object was created with the trace
+ option set to true.
+
+
+
+
+
+ &reftitle.parameters;
+ &no.function.parameters;
+
+
+
+ &reftitle.returnvalues;
+
+ The last SOAP response headers.
+
+
+
+
+ &reftitle.examples;
+
+
+ SoapClient->__getLastResponse() example
+
+ 1));
+$result = $client->SomeFunction();
+echo "RESPONSE HEADERS:\n" . $client->__getLastResponseHeaders() . "\n";
+?>
+]]>
+
+
+
+
+
+
+ &reftitle.seealso;
+
+
+ SoapClient::__getLastRequestHeaders
+ SoapClient::__getLastRequest
+ SoapClient::__getLastResponse
+
+
+
+
+
+
+
diff --git a/reference/soap/functions/soap-soapclient-gettypes.xml b/reference/soap/soapclient/gettypes.xml
similarity index 54%
rename from reference/soap/functions/soap-soapclient-gettypes.xml
rename to reference/soap/soapclient/gettypes.xml
index 827b2f4dd7..f15ee343d7 100644
--- a/reference/soap/functions/soap-soapclient-gettypes.xml
+++ b/reference/soap/soapclient/gettypes.xml
@@ -1,37 +1,45 @@
-
-
-
+
+
+
+
- SoapClient->__getTypes
-
- Returns list of SOAP types
-
+ SoapClient::__getTypes
+ Returns a list of SOAP types
+
&reftitle.description;
-
- SoapClient
-
- array
- __getTypes
-
-
-
+
+ publicarraySoapClient::__getTypes
+
+
- This function works only in WSDL mode.
+ Returns an array of types described in the WSDL for the Web service.
+
+
+ This function only works in WSDL mode.
+
+
+
+
+ &reftitle.parameters;
+ &no.function.parameters;
+
+
&reftitle.returnvalues;
- The list of SOAP types.
+ An array of SOAP types.
+
&reftitle.examples;
- SoapClient->__getTypes() example
+ <function>SoapClient::__getTypes</function> example
__getTypes());
+
&reftitle.seealso;
-
+ SoapClient::SoapClient
+
-
+
+
+
+
- SoapClient->__setCookie
-
- Sets the cookie that will be sent with the SOAP request
-
+ SoapClient::__setCookie
+ The __setCookie purpose
+
&reftitle.description;
-
- SoapClient
-
- void
- __setCookie
- stringname
- stringvalue
-
-
+
+ publicvoidSoapClient::__setCookie
+ stringname
+ stringvalue
+
Defines a cookie to be sent along with the SOAP requests.
@@ -28,6 +24,7 @@
+
&reftitle.parameters;
@@ -51,12 +48,14 @@
+
&reftitle.returnvalues;
- &return.void;
+ &return.void;
+
-
+
+
- SoapClient->__setLocation
-
- Sets the location option.
-
+ SoapClient::__setLocation
+ Sets the location of the Web service to use.
+
&reftitle.description;
-
- SoapClient
-
- string
- __setLocation
- stringlocation
-
-
+
+ publicstringSoapClient::__setLocation
+ stringnew_location
+
- Sets the endpoint URL that will be touched by following SOAP requests.
+ Sets the endpoint URL that will be touched by following SOAP requests. This is equivalent to
+ specifying the location option when constructing the SoapClient.
@@ -27,34 +24,36 @@
+
&reftitle.parameters;
- location
+ new_location
- The URL to be set. If not specified, the existing value of the location
- option will be unset.
+ The new endpoint URL.
+
&reftitle.returnvalues;
- The old value of the location option.
+ The old endpoint URL.
+
&reftitle.examples;
-
-
- Set A Location
-
+
+
+ <function>SoapClient::__setLocation</function> example
+
]]>
-
- &example.outputs;
-
+
+ &example.outputs.similar;
+
-
-
-
+
+
+
+
+
+ &reftitle.seealso;
+
+
+ SoapClient::SoapClient
+
+
+
+
-
+
+
- SoapClient->__setSoapHeaders
-
- Sets SOAP headers for subsequent calls.
-
+ SoapClient::__setSoapHeaders
+ Sets SOAP headers for subsequent calls.
+
&reftitle.description;
-
- SoapClient
-
- bool
- __setSoapHeaders
- mixedheaders
-
-
+
+ publicboolSoapClient::__setSoapHeaders
+ mixedsoapheaders
+
Defines headers to be sent along with the SOAP requests.
@@ -26,12 +22,13 @@
+
&reftitle.parameters;
- headers
+ soapheaders
The headers to be set. If not specified, the headers will be deleted.
@@ -41,18 +38,20 @@
+
&reftitle.returnvalues;
&return.success;
+
&reftitle.examples;
-
-
- Set A Single Header
-
+
+
+ <function>SoapClient::__setSoapHeaders</function> example
+
__setSoapHeaders($header);
$client->__soapCall("echoVoid", null);
?>
]]>
-
-
-
+
+ &example.outputs.similar;
+
+
+
+
+ Set Multiple Headers
diff --git a/reference/soap/soapclient/soapcall.xml b/reference/soap/soapclient/soapcall.xml
new file mode 100644
index 0000000000..2ddd8e72d3
--- /dev/null
+++ b/reference/soap/soapclient/soapcall.xml
@@ -0,0 +1,175 @@
+
+
+
+
+
+ SoapClient::__soapCall
+ Calls a SOAP function
+
+
+
+ &reftitle.description;
+
+ publicmixedSoapClient::__soapCall
+ stringfunction_name
+ arrayarguments
+ arrayoptions
+ mixedinput_headers
+ arrayoutput_headers
+
+
+ This is a low level API function that is used to make a SOAP call. Usually,
+ in WSDL mode,
+ you can simply call SOAP functions as SoapClient
+ methods. This method useful in non-WSDL mode when soapaction
+ is unknown, uri differs from the default or when sending
+ and/or receiving SOAP Headers.
+
+
+ On error, a call to a SOAP function can cause PHP to throw exceptions or return a
+ SoapFault object if exceptions are disabled.
+ To check if the function call failed to catch the SoapFault exceptions,
+ check the result with is_soap_fault.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ function_name
+
+
+ The name of the SOAP function to call.
+
+
+
+
+ arguments
+
+
+ An array of the arguments to pass to the function. This can be either
+ an ordered or an associative array.
+
+
+
+
+ options
+
+
+ An associative array of options to pass to the client.
+
+
+ The location option is the URL of the remote Web service.
+
+
+ The uri option is the target namespace of the SOAP service.
+
+
+ The soapaction option is the action to call.
+
+
+
+
+ input_headers
+
+
+ An array of headers to be sent along with the SOAP request.
+
+
+
+
+ output_headers
+
+
+ If supplied, this array will be filled with the headers from the SOAP response.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ SOAP functions may return one, or multiple values. If only one value is returned
+ by the SOAP function, the return value of __soapCall will be
+ a simple value (e.g. an integer, a string, etc). If multiple values are
+ returned, __soapCall will return
+ an associative array of named output parameters.
+
+
+ On error, if the SoapClient object was constructed with the trace
+ option set to false, a SoapFault object will be returned.
+
+
+
+
+ &reftitle.examples;
+
+
+ <function>SoapClient::__soapCall</function> example
+
+SomeFunction($a, $b, $c);
+
+$client->__soapCall("SomeFunction", array($a, $b, $c));
+$client->__soapCall("SomeFunction", array($a, $b, $c), NULL,
+ new SoapHeader(), $output_headers);
+
+
+$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
+ 'uri' => "http://test-uri/"));
+$client->SomeFunction($a, $b, $c);
+$client->__soapCall("SomeFunction", array($a, $b, $c));
+$client->__soapCall("SomeFunction", array($a, $b, $c),
+ array('soapaction' => 'some_action',
+ 'uri' => 'some_uri'));
+?>
+]]>
+
+
+
+
+
+
+ &reftitle.seealso;
+
+
+ SoapClient::SoapClient
+ SoapParam::SoapParam
+ SoapVar::SoapVar
+ SoapHeader::SoapHeader
+ SoapFault::SoapFault
+ is_soap_fault
+
+
+
+
+
+
+
diff --git a/reference/soap/functions/soap-soapclient-construct.xml b/reference/soap/soapclient/soapclient.xml
similarity index 85%
rename from reference/soap/functions/soap-soapclient-construct.xml
rename to reference/soap/soapclient/soapclient.xml
index 9c04099247..717b7f1b5c 100644
--- a/reference/soap/functions/soap-soapclient-construct.xml
+++ b/reference/soap/soapclient/soapclient.xml
@@ -1,27 +1,25 @@
-
-
-
+
+
+
+
- SoapClient->__construct
-
- SoapClient constructor
-
+ SoapClient::SoapClient
+ SoapClient constructor
+
&reftitle.description;
-
- SoapClient
-
- __construct
- mixedwsdl
- arrayoptions
-
-
+
+ SoapClient::SoapClient
+ mixedwsdl
+ arrayoptions
+
This constructor creates SoapClient objects
in WSDL or non-WSDL mode.
+
&reftitle.parameters;
@@ -86,18 +84,19 @@
Setting the boolean trace option enables use of the
- methods
+ methods
SoapClient->__getLastRequest,
-
+
SoapClient->__getLastRequestHeaders,
-
+
SoapClient->__getLastResponse and
-
+
SoapClient->__getLastResponseHeaders.
The exceptions option is a boolean value defining whether
- soap errors throw exceptions of type
+ soap errors throw exceptions of type
SoapFault.
@@ -140,12 +139,13 @@
+
&reftitle.examples;
-
-
- SoapClient examples
-
+
+
+ <function>SoapClient::SoapClient</function> example
+
array('book' => "MyBo
?>
]]>
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+ The SoapFault class
+ SoapFault
+
+
+
+
+
+ &reftitle.intro;
+
+ Represents a SOAP fault.
+
+
+
+
+
+ &reftitle.classsynopsis;
+
+
+
+ SoapFault
+
+
+
+
+ SoapFault
+
+
+
+ extends
+ Exception
+
+
+
+ Properties
+
+
+ Methods
+
+
+ Inherited methods
+
+
+
+
+
+
+
+
+
+
+ &reftitle.properties;
+
+
+ message
+
+ Prop description
+
+
+
+ code
+
+ Prop description
+
+
+
+ file
+
+ Prop description
+
+
+
+ line
+
+ Prop description
+
+
+
+
+
+
+
+
+
+ &reference.soap.entities.soapfault;
+
+
+
+
diff --git a/reference/soap/functions/soap-soapfault-construct.xml b/reference/soap/soapfault/soapfault.xml
similarity index 70%
rename from reference/soap/functions/soap-soapfault-construct.xml
rename to reference/soap/soapfault/soapfault.xml
index c823f117b8..eba83446cd 100644
--- a/reference/soap/functions/soap-soapfault-construct.xml
+++ b/reference/soap/soapfault/soapfault.xml
@@ -1,33 +1,31 @@
-
-
-
+
+
+
+
- SoapFault->__construct
-
- SoapFault constructor
-
+ SoapFault::SoapFault
+ SoapFault constructor
+
&reftitle.description;
-
- SoapFault
-
- __construct
- stringfaultcode
- stringfaultstring
- stringfaultactor
- mixeddetail
- stringfaultname
- SoapHeaderheaderfault
-
-
+
+ SoapFault::SoapFault
+ stringfaultcode
+ stringfaultstring
+ stringfaultactor
+ stringdetail
+ stringfaultname
+ stringheaderfault
+
This class is useful when you would like to send SOAP fault responses from
the PHP handler. faultcode, faultstring,
faultactor and details are
- standard elements of SOAP Fault;
+ standard elements of a SOAP Fault.
+
&reftitle.parameters;
@@ -60,6 +58,7 @@
detail
+ More details about the cause of the error.
@@ -67,7 +66,7 @@
faultname
- Can be used to select the proper fault encoding from WSDL.
+ Can be used to select the proper fault encoding from WSDL.
@@ -83,6 +82,7 @@
+
&reftitle.examples;
@@ -127,19 +127,17 @@ $server->handle();
+
&reftitle.seealso;
-
-
-
-
-
+ SoapServer::faultis_soap_fault
+
+
+
+
+ SoapFault::__toString
+ Obtain a string representation of a SoapFault
+
+
+
+ &reftitle.description;
+
+ publicvoidSoapFault::__toString
+
+
+
+ Returns a string representation of the SoapFault.
+
+
+
+
+ &reftitle.parameters;
+ &no.function.parameters;
+
+
+
+ &reftitle.returnvalues;
+
+ A string describing the SoapFault.
+
+
+
+
+
+
diff --git a/reference/soap/soapheader.xml b/reference/soap/soapheader.xml
new file mode 100644
index 0000000000..bd1622d0de
--- /dev/null
+++ b/reference/soap/soapheader.xml
@@ -0,0 +1,67 @@
+
+
+
+
+
+ The SoapHeader class
+ SoapHeader
+
+
+
+
+
+ &reftitle.intro;
+
+ Represents a SOAP header.
+
+
+
+
+
+ &reftitle.classsynopsis;
+
+
+
+ SoapHeader
+
+
+
+
+ SoapHeader
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+
+ &reference.soap.entities.soapheader;
+
+
+
+
diff --git a/reference/soap/functions/soap-soapheader-construct.xml b/reference/soap/soapheader/soapheader.xml
similarity index 53%
rename from reference/soap/functions/soap-soapheader-construct.xml
rename to reference/soap/soapheader/soapheader.xml
index 2de07a2347..628ccf1b28 100644
--- a/reference/soap/functions/soap-soapheader-construct.xml
+++ b/reference/soap/soapheader/soapheader.xml
@@ -1,29 +1,27 @@
-
-
-
+
+
+
+
- SoapHeader->__construct
-
- SoapHeader constructor
-
+ SoapHeader::SoapHeader
+ SoapHeader constructor
+
&reftitle.description;
-
- SoapHeader
-
- __construct
- stringnamespace
- stringname
- mixeddata
- boolmustUnderstand
- mixedactor
-
-
+
+ SoapHeader::SoapHeader
+ stringnamespace
+ stringname
+ mixeddata
+ boolmustunderstand
+ stringactor
+
- Constructs a new SoapHeader object.
+ Constructs a new SoapHeader object.
+
&reftitle.parameters;
@@ -40,7 +38,7 @@
name
- The name of the SOAP header element.
+ The name of the SoapHeader object.
@@ -74,11 +72,12 @@
+
&reftitle.examples;
- Basic Example
+ <function>SoapHeader::SoapHeader</function> example
__soapCall("echoVoid", null, null,
'echoMeStringRequest',
'hello world'));
?>
-]]>
-
-
-
-
-
- Complex Type With Attributes
-
- 'value1', 'attr2' => 'value2');
-
-// the type_name and type_namespace parameters must be specified
-// when specifying attributes
-$complex_type = new SOAPVar($attributes,
- SOAP_ENC_OBJECT,
- 'ComplexType', // type_name
- 'http://www.example.com/namespace', // type_namespace
- 'complex_type',
- 'http://www.example.com/namespace');
-
-
-$header = new SOAPHeader('http://www.example.com/namespace',
- 'ComplexType',
- $complex_type,
- true);
-
-$client->__soapCall("someFunc", null, null, $header);
-?>
]]>
+
&reftitle.seealso;
-
-
-
+ SoapClient::__soapCall
+ SoapVar::SoapVar
+ SoapParam::SoapParam
+
+
+
+
+ The SoapParam class
+ SoapParam
+
+
+
+
+
+ &reftitle.intro;
+
+ Represents parameter to a SOAP call.
+
+
+
+
+
+ &reftitle.classsynopsis;
+
+
+
+ SoapParam
+
+
+
+
+ SoapParam
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+
+ &reference.soap.entities.soapparam;
+
+
+
+
diff --git a/reference/soap/functions/soap-soapparam-construct.xml b/reference/soap/soapparam/soapparam.xml
similarity index 70%
rename from reference/soap/functions/soap-soapparam-construct.xml
rename to reference/soap/soapparam/soapparam.xml
index 3814821963..60e0cd4e63 100644
--- a/reference/soap/functions/soap-soapparam-construct.xml
+++ b/reference/soap/soapparam/soapparam.xml
@@ -1,26 +1,24 @@
-
-
-
+
+
+
+
- SoapParam->__construct
-
- SoapParam constructor
-
+ SoapParam::SoapParam
+ SoapParam constructor
+
&reftitle.description;
-
- SoapParam
-
- __construct
- mixeddata
- stringname
-
-
+
+ SoapParam::SoapParam
+ mixeddata
+ stringname
+
Constructs a new SoapParam object.
+
&reftitle.parameters;
@@ -46,11 +44,12 @@
+
&reftitle.examples;
- Some examples
+ <function>SoapParam::SoapParam</function> example
SomeFunction(new SoapParam($a, "a"),
?>
]]>
+ &example.outputs.similar;
+
+
+
+
&reftitle.seealso;
-
-
+ SoapClient::__soapCall
+ SoapVar::SoapVar
+
+
+
+
+ The SoapServer class
+ SoapServer
+
+
+
+
+
+ &reftitle.intro;
+
+ The SoapServer class provides a server for the SOAP 1.1 and SOAP 1.2 protocols. It can be used with or without a WSDL service description.
+
+
+
+
+
+ &reftitle.classsynopsis;
+
+
+
+ SoapServer
+
+
+
+
+ SoapServer
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+
+ &reference.soap.entities.soapserver;
+
+
+
+
diff --git a/reference/soap/functions/soap-soapserver-addfunction.xml b/reference/soap/soapserver/addfunction.xml
similarity index 74%
rename from reference/soap/functions/soap-soapserver-addfunction.xml
rename to reference/soap/soapserver/addfunction.xml
index 3909b77ed6..220717b41d 100644
--- a/reference/soap/functions/soap-soapserver-addfunction.xml
+++ b/reference/soap/soapserver/addfunction.xml
@@ -1,25 +1,23 @@
-
-
-
+
+
+
+
- SoapServer->addFunction
-
- Adds one or several functions those will handle SOAP requests
-
+ SoapServer::addFunction
+ Adds one or more functions to handle SOAP requests
+
&reftitle.description;
-
- SoapServer
-
- voidaddFunction
- mixedfunctions
-
-
+
+ publicvoidSoapServer::addFunction
+ stringfunctions
+
- Exports one or more functions for remote clients.
+ Exports one or more functions for remote clients
+
&reftitle.parameters;
@@ -50,17 +48,19 @@
+
&reftitle.returnvalues;
&return.void;
+
&reftitle.examples;
- Some examples
+ <function>SoapServer::addFunction</function> example
addFunction(SOAP_FUNCTIONS_ALL);
+
&reftitle.seealso;
-
-
+ SoapServer::SoapServer
+ SoapServer::setClass
+
+
+
+
+ SoapServer::addSoapHeader
+ Add a SOAP header to the response
+
+
+
+ &reftitle.description;
+
+ publicvoidSoapServer::addSoapHeader
+ stringobject
+
+
+ Adds a SOAP header to be returned with the response to the current request.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ object
+
+
+ The header to be returned.
+
+
+
+
+
+
+
+
+
+
diff --git a/reference/soap/soapserver/fault.xml b/reference/soap/soapserver/fault.xml
new file mode 100644
index 0000000000..6ecd6278d4
--- /dev/null
+++ b/reference/soap/soapserver/fault.xml
@@ -0,0 +1,115 @@
+
+
+
+
+
+ SoapServer::fault
+ Issue SoapServer fault indicating an error
+
+
+
+ &reftitle.description;
+
+ publicvoidSoapServer::fault
+ stringcode
+ stringstring
+ stringactor
+ stringdetails
+ stringname
+
+
+ Sends a response to the client of the current request indicating an error.
+
+
+
+ This can only be called when handling a request.
+
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ code
+
+
+ The error code to return
+
+
+
+
+ string
+
+
+ A brief description of the error
+
+
+
+
+ actor
+
+
+ A string identifying the actor that caused the fault.
+
+
+
+
+ details
+
+
+ More details of the fault
+
+
+
+
+ name
+
+
+ The name of the fault. This can be used to select a name from a WSDL file.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.void;
+
+
+
+
+ &reftitle.seealso;
+
+
+ SoapFault::SoapFault
+
+
+
+
+
+
+
diff --git a/reference/soap/functions/soap-soapserver-getfunctions.xml b/reference/soap/soapserver/getfunctions.xml
similarity index 56%
rename from reference/soap/functions/soap-soapserver-getfunctions.xml
rename to reference/soap/soapserver/getfunctions.xml
index d0d14add75..9b871842b0 100644
--- a/reference/soap/functions/soap-soapserver-getfunctions.xml
+++ b/reference/soap/soapserver/getfunctions.xml
@@ -1,39 +1,43 @@
-
-
-
+
+
+
+
- SoapServer->getFunctions
-
- Returns list of defined functions
-
+ SoapServer::getFunctions
+ Returns list of defined functions
+
&reftitle.description;
-
- SoapServer
-
- array
- getFunctions
-
-
-
+
+ publicarraySoapServer::getFunctions
+
+
+ Returns a list of the defined functions in the SoapServer object.
This method returns the list of all functions added by
- or
- .
+ SoapServer::addFunction or
+ SoapServer::setClass.
+
+
+ &reftitle.parameters;
+ &no.function.parameters;
+
+
&reftitle.returnvalues;
- The list of all functions.
+ An array of the defined functions.
+
&reftitle.examples;
- Some examples
+ <function>SoapServer::getFunctions</function> example
+
&reftitle.seealso;
-
-
-
+ SoapServer::SoapServer
+ SoapServer::addFunction
+ SoapServer::setClass
+
-
+
+
+
+
- SoapServer->handle
-
- Handles a SOAP request
-
+ SoapServer::handle
+ Handles a SOAP request
+
&reftitle.description;
-
- SoapServer
-
- voidhandle
- stringsoap_request
-
-
+
+ publicvoidSoapServer::handle
+ stringsoap_request
+
Processes a SOAP request, calls necessary functions, and sends a response
back.
+
&reftitle.parameters;
@@ -29,25 +27,27 @@
soap_request
- The SOAP request. If this argument is omitted, the request is supposed
- to be in the $HTTP_RAW_POST_DATA PHP variable.
+ The SOAP request. If this argument is omitted, the request is assumed to be
+ in the raw POST data of the HTTP request.
+
&reftitle.returnvalues;
&return.void;
+
&reftitle.examples;
- Some examples
+ <function>SoapServer::handle</function> example
handle();
+
&reftitle.seealso;
-
+ SoapServer::SoapServer
+
-
+
+
+
+
- SoapServer->setClass
-
- Sets class which will handle SOAP requests
-
+ SoapServer::setClass
+ Sets the class which handles SOAP requests
+
&reftitle.description;
-
- SoapServer
-
- voidsetClass
- stringclass_name
- mixedargs
- mixed...
-
-
+
+ publicvoidSoapServer::setClass
+ stringclass_name
+ stringargs
+
Exports all methods from specified class.
The object can be made persistent across request for a given PHP session
- with the method.
+ with the SoapServer::setPersistence method.
+
&reftitle.parameters;
@@ -50,51 +47,25 @@
+
&reftitle.returnvalues;
&return.void;
-
- &reftitle.examples;
-
-
- Some examples
-
-setClass("foo");
-
-class bar {
- function bar($x, $y)
- {
- }
-}
-$server->setClass("bar", $arg1, $arg2);
-
-?>
-]]>
-
-
-
-
&reftitle.seealso;
-
-
-
+ SoapServer::SoapServer
+ SoapServer::addFunction
+ SoapServer::setPersistence
+
+
+
+
+ SoapServer::setObject
+ Sets the object which will be used to handle SOAP requests
+
+
+
+ &reftitle.description;
+
+ publicvoidSoapServer::setObject
+ stringobject
+
+
+ This sets a specific object as the handler for SOAP requests, rather than just a class as in
+ SoapServer::setClass.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ object
+
+
+ The object to handle the requests.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.void;
+
+
+
+
+
+ &reftitle.seealso;
+
+
+ SoapServer::setClass
+
+
+
+
+
+
+
diff --git a/reference/soap/functions/soap-soapserver-setpersistence.xml b/reference/soap/soapserver/setpersistence.xml
similarity index 51%
rename from reference/soap/functions/soap-soapserver-setpersistence.xml
rename to reference/soap/soapserver/setpersistence.xml
index 1964457e96..bafe5ee168 100644
--- a/reference/soap/functions/soap-soapserver-setpersistence.xml
+++ b/reference/soap/soapserver/setpersistence.xml
@@ -1,27 +1,33 @@
-
-
-
+
+
+
+
- SoapServer->setPersistence
-
- Sets persistence mode of SoapServer
-
+ SoapServer::setPersistence
+ Sets SoapServer persistence mode
+
&reftitle.description;
-
- SoapServer
-
- voidsetPersistence
- intmode
-
-
+
+ publicvoidSoapServer::setPersistence
+ stringmode
+
This function allows saving data between requests in a PHP session. It works only
- with a server that exports functions from a class with
- .
+ with a server that exports functions from a class with SoapServer::setClass
+ or SoapServer::setObject.
+
+
+ The persistence
+ SOAP_PERSISTENCE_SESSION makes persistent only object
+ of given class, but not the class static data. You may use $this->bar
+ instead of self::$bar.
+
+
+
&reftitle.parameters;
@@ -32,54 +38,30 @@
One of the SOAP_PERSISTENCE_XXX constants.
+
+ SOAP_PERSISTENCE_REQUEST - persist the object for the duration of a request.
+
+
+ SOAP_PERSISTENCE_SESSION - persist the object for the duration of a session.
+
-
- &reftitle.returnvalues;
-
- &return.void;
-
-
-
- &reftitle.examples;
-
-
- Some examples
-
-setPersistence(SOAP_PERSISTENCE_SESSION);
-
-$server->setPersistence(SOAP_PERSISTENCE_REQUEST);
-
-?>
-]]>
-
-
-
-
- The persistence
- SOAP_PERSISTENCE_SESSION makes persistent only object
- of given class, but not the class static data. You may use $this->bar
- instead of self::$bar.
-
-
-
-
&reftitle.seealso;
-
-
+ SoapServer::setClass
+ SoapServer::setObject
+
+
-
+
+
+
+
- SoapServer->__construct
-
- SoapServer constructor
-
+ SoapServer::SoapServer
+ SoapServer constructor
+
&reftitle.description;
-
- SoapServer
-
- __construct
- mixedwsdl
- arrayoptions
-
-
+
+ SoapServer::SoapServer
+ mixedwsdl
+ arrayoptions
+
This constructor allows the creation of SoapServer
objects in WSDL or non-WSDL mode.
+
&reftitle.parameters;
@@ -30,9 +28,9 @@
wsdl
- If you want the WSDL mode, you must set this to the URI of a WSDL file.
- In the other case, you must set this to &null; and set the uri
- option.
+ To use the SoapServer in WSDL mode, pass the URI of a WSDL file.
+ Otherwise, pass &null; and set the uri option to the
+ target namespace for the server.
@@ -57,19 +55,26 @@
(callback accepting one object parameter).
- Other options are features and
- cache_wsdl.
+ The cache_wsdl option is one of
+ WSDL_CACHE_NONE,
+ WSDL_CACHE_DISK,
+ WSDL_CACHE_MEMORY or
+ WSDL_CACHE_BOTH.
+
+
+ There is also a features option.
+
&reftitle.examples;
- Some examples
+ <function>SoapServer::SoapServer</function> example
array('book' => "MyBo
+
+
+ &reftitle.seealso;
+
+
+ SoapClient::SoapClient
+
+
+
+
+
+
+
+ The SoapVar class
+ SoapVar
+
+
+
+
+
+ &reftitle.intro;
+
+ A class representing a variable or object for use with SOAP services.
+
+
+
+
+
+ &reftitle.classsynopsis;
+
+
+
+ SoapVar
+
+
+
+
+ SoapVar
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+
+ &reference.soap.entities.soapvar;
+
+
+
+
diff --git a/reference/soap/functions/soap-soapvar-construct.xml b/reference/soap/soapvar/soapvar.xml
similarity index 70%
rename from reference/soap/functions/soap-soapvar-construct.xml
rename to reference/soap/soapvar/soapvar.xml
index a11387f8f2..f611b8f93f 100644
--- a/reference/soap/functions/soap-soapvar-construct.xml
+++ b/reference/soap/soapvar/soapvar.xml
@@ -1,30 +1,28 @@
-
-
-
+
+
+
+
- SoapVar->__construct
-
- SoapVar constructor
-
+ SoapVar::SoapVar
+ SoapVar constructor
+
&reftitle.description;
-
- SoapVar
-
- __construct
- mixeddata
- intencoding
- stringtype_name
- stringtype_namespace
- stringnode_name
- stringnode_namespace
-
-
+
+ SoapVar::SoapVar
+ stringdata
+ stringencoding
+ stringtype_name
+ stringtype_namespace
+ stringnode_name
+ stringnode_namespace
+
Constructs a new SoapVar object.
+
&reftitle.parameters;
@@ -80,11 +78,12 @@
+
&reftitle.examples;
- Some examples
+ <function>SoapVar::SoapVar</function> example
echoStruct(new SoapParam($soapstruct, "inputStruct"));
+
&reftitle.seealso;
-
-
+ SoapClient::__soapCall
+ SoapParam::SoapParam
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
+-->