From 18a3b717d6186bff612376d78808645bc6778676 Mon Sep 17 00:00:00 2001 From: Michael Maclean Date: Mon, 16 Feb 2009 21:27:28 +0000 Subject: [PATCH] Update ext/soap docs to the new markup git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275958 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/soap/book.xml | 22 +- reference/soap/configure.xml | 32 + reference/soap/constants.xml | 1589 ++++++++--------- reference/soap/functions/is-soap-fault.xml | 34 +- .../soap/functions/soap-soapclient-call.xml | 50 - .../soap-soapclient-getlastrequestheaders.xml | 65 - ...soap-soapclient-getlastresponseheaders.xml | 65 - .../functions/soap-soapclient-soapcall.xml | 112 -- .../soap/functions/soap-soapserver-fault.xml | 52 - .../soap/functions/use-soap-error-handler.xml | 46 +- reference/soap/ini.xml | 211 +-- reference/soap/reference.xml | 174 +- reference/soap/setup.xml | 12 +- reference/soap/soapclient.xml | 69 + reference/soap/soapclient/call.xml | 44 + reference/soap/soapclient/construct.xml | 43 + .../dorequest.xml} | 62 +- .../getfunctions.xml} | 49 +- .../getlastrequest.xml} | 49 +- .../soap/soapclient/getlastrequestheaders.xml | 90 + .../getlastresponse.xml} | 51 +- .../soapclient/getlastresponseheaders.xml | 90 + .../gettypes.xml} | 48 +- .../setcookie.xml} | 33 +- .../setlocation.xml} | 67 +- .../setsoapheaders.xml} | 49 +- reference/soap/soapclient/soapcall.xml | 175 ++ .../soapclient.xml} | 59 +- reference/soap/soapfault.xml | 112 ++ .../soapfault.xml} | 50 +- reference/soap/soapfault/tostring.xml | 54 + reference/soap/soapheader.xml | 67 + .../soapheader.xml} | 80 +- reference/soap/soapparam.xml | 67 + .../soapparam.xml} | 43 +- reference/soap/soapserver.xml | 68 + .../addfunction.xml} | 38 +- reference/soap/soapserver/addsoapheader.xml | 58 + reference/soap/soapserver/fault.xml | 115 ++ .../getfunctions.xml} | 50 +- .../handle.xml} | 38 +- .../setclass.xml} | 67 +- reference/soap/soapserver/setobject.xml | 76 + .../setpersistence.xml} | 82 +- .../soapserver.xml} | 57 +- reference/soap/soapvar.xml | 67 + .../soapvar.xml} | 45 +- reference/soap/versions.xml | 71 +- 48 files changed, 2719 insertions(+), 2028 deletions(-) create mode 100644 reference/soap/configure.xml delete mode 100644 reference/soap/functions/soap-soapclient-call.xml delete mode 100644 reference/soap/functions/soap-soapclient-getlastrequestheaders.xml delete mode 100644 reference/soap/functions/soap-soapclient-getlastresponseheaders.xml delete mode 100644 reference/soap/functions/soap-soapclient-soapcall.xml delete mode 100644 reference/soap/functions/soap-soapserver-fault.xml create mode 100644 reference/soap/soapclient.xml create mode 100644 reference/soap/soapclient/call.xml create mode 100644 reference/soap/soapclient/construct.xml rename reference/soap/{functions/soap-soapclient-dorequest.xml => soapclient/dorequest.xml} (66%) rename reference/soap/{functions/soap-soapclient-getfunctions.xml => soapclient/getfunctions.xml} (57%) rename reference/soap/{functions/soap-soapclient-getlastrequest.xml => soapclient/getlastrequest.xml} (56%) create mode 100644 reference/soap/soapclient/getlastrequestheaders.xml rename reference/soap/{functions/soap-soapclient-getlastresponse.xml => soapclient/getlastresponse.xml} (54%) create mode 100644 reference/soap/soapclient/getlastresponseheaders.xml rename reference/soap/{functions/soap-soapclient-gettypes.xml => soapclient/gettypes.xml} (54%) rename reference/soap/{functions/soap-soapclient-setcookie.xml => soapclient/setcookie.xml} (67%) rename reference/soap/{functions/soap-soapclient-setlocation.xml => soapclient/setlocation.xml} (55%) rename reference/soap/{functions/soap-soapclient-setsoapheaders.xml => soapclient/setsoapheaders.xml} (74%) create mode 100644 reference/soap/soapclient/soapcall.xml rename reference/soap/{functions/soap-soapclient-construct.xml => soapclient/soapclient.xml} (85%) create mode 100644 reference/soap/soapfault.xml rename reference/soap/{functions/soap-soapfault-construct.xml => soapfault/soapfault.xml} (70%) create mode 100644 reference/soap/soapfault/tostring.xml create mode 100644 reference/soap/soapheader.xml rename reference/soap/{functions/soap-soapheader-construct.xml => soapheader/soapheader.xml} (53%) create mode 100644 reference/soap/soapparam.xml rename reference/soap/{functions/soap-soapparam-construct.xml => soapparam/soapparam.xml} (70%) create mode 100644 reference/soap/soapserver.xml rename reference/soap/{functions/soap-soapserver-addfunction.xml => soapserver/addfunction.xml} (74%) create mode 100644 reference/soap/soapserver/addsoapheader.xml create mode 100644 reference/soap/soapserver/fault.xml rename reference/soap/{functions/soap-soapserver-getfunctions.xml => soapserver/getfunctions.xml} (56%) rename reference/soap/{functions/soap-soapserver-handle.xml => soapserver/handle.xml} (68%) rename reference/soap/{functions/soap-soapserver-setclass.xml => soapserver/setclass.xml} (52%) create mode 100644 reference/soap/soapserver/setobject.xml rename reference/soap/{functions/soap-soapserver-setpersistence.xml => soapserver/setpersistence.xml} (51%) rename reference/soap/{functions/soap-soapserver-construct.xml => soapserver/soapserver.xml} (66%) create mode 100644 reference/soap/soapvar.xml rename reference/soap/{functions/soap-soapvar-construct.xml => soapvar/soapvar.xml} (70%) diff --git a/reference/soap/book.xml b/reference/soap/book.xml index 72d247cf62..7f42ce4b3f 100644 --- a/reference/soap/book.xml +++ b/reference/soap/book.xml @@ -1,12 +1,10 @@ - - - - + + SOAP - - + SOAP + &reftitle.intro; @@ -16,12 +14,20 @@ xlink:href="&spec.wsdl;">WSDL 1.1 specifications. - - + &reference.soap.setup; &reference.soap.constants; + &reference.soap.reference; + &reference.soap.soapclient; + &reference.soap.soapserver; + &reference.soap.soapfault; + &reference.soap.soapheader; + &reference.soap.soapparam; + &reference.soap.soapvar; + + + +
+ &reftitle.install; + + + To enable SOAP support, configure PHP with --enable-soap. + +
+ + + diff --git a/reference/soap/constants.xml b/reference/soap/constants.xml index 56f84d3c88..1f6bec4f47 100644 --- a/reference/soap/constants.xml +++ b/reference/soap/constants.xml @@ -1,825 +1,783 @@ - - - - + + + + &reftitle.constants; &extension.constants; - - - - SOAP_1_1 - (integer) - - - - - - - - - - SOAP_1_2 - (integer) - - - - - - - - - - SOAP_PERSISTENCE_SESSION - (integer) - - - - - - - - - - SOAP_PERSISTENCE_REQUEST - (integer) - - - - - - - - - - SOAP_FUNCTIONS_ALL - (integer) - - - - - - - - - - SOAP_ENCODED - (integer) - - - - - - - - - - SOAP_LITERAL - (integer) - - - - - - - - - - SOAP_RPC - (integer) - - - - - - - - - - SOAP_DOCUMENT - (integer) - - - - - - - - - - SOAP_ACTOR_NEXT - (integer) - - - - - - - - - - SOAP_ACTOR_NONE - (integer) - - - - - - - - - - SOAP_ACTOR_UNLIMATERECEIVER - (integer) - - - - - - - - - - SOAP_COMPRESSION_ACCEPT - (integer) - - - - - - - - - - SOAP_COMPRESSION_GZIP - (integer) - - - - - - - - - - SOAP_COMPRESSION_DEFLATE - (integer) - - - - - - - - - - SOAP_WAIT_ONE_WAY_CALLS - (integer) - - - - Added in PHP 5.1.0. - - - - - - SOAP_USE_XSI_ARRAY_TYPE - (integer) - - - - - - - - - SOAP_SINGLE_ELEMENT_ARRAYS - (integer) - - - - - - - - - UNKNOWN_TYPE - (integer) - - - - - - - - - - XSD_STRING - (integer) - - - - - - - - - - XSD_BOOLEAN - (integer) - - - - - - - - - - XSD_DECIMAL - (integer) - - - - - - - - - - XSD_FLOAT - (integer) - - - - - - - - - - XSD_DOUBLE - (integer) - - - - - - - - - - XSD_DURATION - (integer) - - - - - - - - - - XSD_DATETIME - (integer) - - - - - - - - - - XSD_TIME - (integer) - - - - - - - - - - XSD_DATE - (integer) - - - - - - - - - - XSD_GYEARMONTH - (integer) - - - - - - - - - - XSD_GYEAR - (integer) - - - - - - - - - - XSD_GMONTHDAY - (integer) - - - - - - - - - - XSD_GDAY - (integer) - - - - - - - - - - XSD_GMONTH - (integer) - - - - - - - - - - XSD_HEXBINARY - (integer) - - - - - - - - - - XSD_BASE64BINARY - (integer) - - - - - - - - - - XSD_ANYURI - (integer) - - - - - - - - - - XSD_ANYXML - (integer) - - - - Added in PHP 5.1.0. - - - - - - XSD_QNAME - (integer) - - - - - - - - - - XSD_NOTATION - (integer) - - - - - - - - - - XSD_NORMALIZEDSTRING - (integer) - - - - - - - - - - XSD_TOKEN - (integer) - - - - - - - - - - XSD_LANGUAGE - (integer) - - - - - - - - - - XSD_NMTOKEN - (integer) - - - - - - - - - - XSD_NAME - (integer) - - - - - - - - - - XSD_NCNAME - (integer) - - - - - - - - - - XSD_ID - (integer) - - - - - - - - - - XSD_IDREF - (integer) - - - - - - - - - - XSD_IDREFS - (integer) - - - - - - - - - - XSD_ENTITY - (integer) - - - - - - - - - - XSD_ENTITIES - (integer) - - - - - - - - - - XSD_INTEGER - (integer) - - - - - - - - - - XSD_NONPOSITIVEINTEGER - (integer) - - - - - - - - - - XSD_NEGATIVEINTEGER - (integer) - - - - - - - - - - XSD_LONG - (integer) - - - - - - - - - - XSD_INT - (integer) - - - - - - - - - - XSD_SHORT - (integer) - - - - - - - - - - XSD_BYTE - (integer) - - - - - - - - - - XSD_NONNEGATIVEINTEGER - (integer) - - - - - - - - - - XSD_UNSIGNEDLONG - (integer) - - - - - - - - - - XSD_UNSIGNEDINT - (integer) - - - - - - - - - - XSD_UNSIGNEDSHORT - (integer) - - - - - - - - - - XSD_UNSIGNEDBYTE - (integer) - - - - - - - - - - XSD_POSITIVEINTEGER - (integer) - - - - - - - - - - XSD_NMTOKENS - (integer) - - - - - - - - - - XSD_ANYTYPE - (integer) - - - - - - - - - - SOAP_ENC_OBJECT - (integer) - - - - - - - - - - SOAP_ENC_ARRAY - (integer) - - - - - - - - - - XSD_1999_TIMEINSTANT - (integer) - - - - - - - - - - XSD_NAMESPACE + + + + + SOAP_1_1 + (integer) + + + + + + + + + SOAP_1_2 + (integer) + + + + + + + + + SOAP_PERSISTENCE_SESSION + (integer) + + + + + + + + + SOAP_PERSISTENCE_REQUEST + (integer) + + + + + + + + + SOAP_FUNCTIONS_ALL + (integer) + + + + + + + + + SOAP_ENCODED + (integer) + + + + + + + + + SOAP_LITERAL + (integer) + + + + + + + + + SOAP_RPC + (integer) + + + + + + + + + SOAP_DOCUMENT + (integer) + + + + + + + + + SOAP_ACTOR_NEXT + (integer) + + + + + + + + + SOAP_ACTOR_NONE + (integer) + + + + + + + + + SOAP_ACTOR_UNLIMATERECEIVER + (integer) + + + + + + + + + SOAP_COMPRESSION_ACCEPT + (integer) + + + + + + + + + SOAP_COMPRESSION_GZIP + (integer) + + + + + + + + + SOAP_COMPRESSION_DEFLATE + (integer) + + + + + + + + + SOAP_AUTHENTICATION_BASIC + (integer) + + + + + + + + + SOAP_AUTHENTICATION_DIGEST + (integer) + + + + + + + + + UNKNOWN_TYPE + (integer) + + + + + + + + + XSD_STRING + (integer) + + + + + + + + + XSD_BOOLEAN + (integer) + + + + + + + + + XSD_DECIMAL + (integer) + + + + + + + + + XSD_FLOAT + (integer) + + + + + + + + + XSD_DOUBLE + (integer) + + + + + + + + + XSD_DURATION + (integer) + + + + + + + + + XSD_DATETIME + (integer) + + + + + + + + + XSD_TIME + (integer) + + + + + + + + + XSD_DATE + (integer) + + + + + + + + + XSD_GYEARMONTH + (integer) + + + + + + + + + XSD_GYEAR + (integer) + + + + + + + + + XSD_GMONTHDAY + (integer) + + + + + + + + + XSD_GDAY + (integer) + + + + + + + + + XSD_GMONTH + (integer) + + + + + + + + + XSD_HEXBINARY + (integer) + + + + + + + + + XSD_BASE64BINARY + (integer) + + + + + + + + + XSD_ANYURI + (integer) + + + + + + + + + XSD_QNAME + (integer) + + + + + + + + + XSD_NOTATION + (integer) + + + + + + + + + XSD_NORMALIZEDSTRING + (integer) + + + + + + + + + XSD_TOKEN + (integer) + + + + + + + + + XSD_LANGUAGE + (integer) + + + + + + + + + XSD_NMTOKEN + (integer) + + + + + + + + + XSD_NAME + (integer) + + + + + + + + + XSD_NCNAME + (integer) + + + + + + + + + XSD_ID + (integer) + + + + + + + + + XSD_IDREF + (integer) + + + + + + + + + XSD_IDREFS + (integer) + + + + + + + + + XSD_ENTITY + (integer) + + + + + + + + + XSD_ENTITIES + (integer) + + + + + + + + + XSD_INTEGER + (integer) + + + + + + + + + XSD_NONPOSITIVEINTEGER + (integer) + + + + + + + + + XSD_NEGATIVEINTEGER + (integer) + + + + + + + + + XSD_LONG + (integer) + + + + + + + + + XSD_INT + (integer) + + + + + + + + + XSD_SHORT + (integer) + + + + + + + + + XSD_BYTE + (integer) + + + + + + + + + XSD_NONNEGATIVEINTEGER + (integer) + + + + + + + + + XSD_UNSIGNEDLONG + (integer) + + + + + + + + + XSD_UNSIGNEDINT + (integer) + + + + + + + + + XSD_UNSIGNEDSHORT + (integer) + + + + + + + + + XSD_UNSIGNEDBYTE + (integer) + + + + + + + + + XSD_POSITIVEINTEGER + (integer) + + + + + + + + + XSD_NMTOKENS + (integer) + + + + + + + + + XSD_ANYTYPE + (integer) + + + + + + + + + XSD_ANYXML + (integer) + + + + + + + + + APACHE_MAP + (integer) + + + + + + + + + SOAP_ENC_OBJECT + (integer) + + + + + + + + + SOAP_ENC_ARRAY + (integer) + + + + + + + + + XSD_1999_TIMEINSTANT + (integer) + + + + + + + + + XSD_NAMESPACE (string) - - - - - - - - - - XSD_1999_NAMESPACE + + + + + + + + + XSD_1999_NAMESPACE (string) - - - - - - - - - - WSDL_CACHE_NONE + + + + + + + + + SOAP_SINGLE_ELEMENT_ARRAYS (integer) - - - - Switches off WSDL caching even if - soap.wsdl_cache_enabled - is on. Available since PHP 5.1.5. - - - - - - WSDL_CACHE_DISK + + + + + + + + + SOAP_WAIT_ONE_WAY_CALLS (integer) - - - - Available since PHP 5.1.5. - - - - - - WSDL_CACHE_MEMORY + + + + + + + + + SOAP_USE_XSI_ARRAY_TYPE (integer) - - - - Caches WSDL data in process memory. Available since PHP 5.1.5. - - - - - - WSDL_CACHE_BOTH + + + + + + + + + WSDL_CACHE_NONE (integer) - - - - Available since PHP 5.1.5. - - - - + + + + + + + + + WSDL_CACHE_DISK + (integer) + + + + + + + + + WSDL_CACHE_MEMORY + (integer) + + + + + + + + + WSDL_CACHE_BOTH + (integer) + + + + + + + + + diff --git a/reference/soap/functions/is-soap-fault.xml b/reference/soap/functions/is-soap-fault.xml index 36253e4d50..5150ea2240 100644 --- a/reference/soap/functions/is-soap-fault.xml +++ b/reference/soap/functions/is-soap-fault.xml @@ -1,21 +1,21 @@ - - - + + + + is_soap_fault - - Checks if SOAP call was failed - + Checks if a SOAP call has failed + &reftitle.description; boolis_soap_fault - mixedobj + mixedobject - This function is useful when you like to check if the SOAP call failed, but - don't like to use exceptions. To use it you must create a + This function is useful to check if the SOAP call failed, but + without using exceptions. To use it, create a SoapClient object with the exceptions option set to zero or &false;. In this case, the SOAP method will return a special @@ -29,27 +29,31 @@ parameter is a SoapFault object. + &reftitle.parameters; - obj + object - The tested object. + The object to test. + &reftitle.returnvalues; + - &return.success; + This will return true on error, and false otherwise. + &reftitle.examples; @@ -84,15 +88,17 @@ try { + &reftitle.seealso; - - + SoapClient::SoapClient + SoapFault::SoapFault + - - - SoapClient->__call - - Calls a SOAP function (deprecated) - - - - &reftitle.description; - - SoapClient - - mixed - __call - stringfunction_name - arrayarguments - arrayoptions - arrayinput_headers - arrayoutput_headers - - - - This method is deprecated. Use instead of it. - - - - - diff --git a/reference/soap/functions/soap-soapclient-getlastrequestheaders.xml b/reference/soap/functions/soap-soapclient-getlastrequestheaders.xml deleted file mode 100644 index a5e4335a27..0000000000 --- a/reference/soap/functions/soap-soapclient-getlastrequestheaders.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - SoapClient->__getLastRequestHeaders - - Returns last SOAP request headers - - - - &reftitle.description; - - SoapClient - - string - __getLastRequestHeaders - - - - - - This method works only if the SoapClient object - was created with the trace option. - - - - - &reftitle.returnvalues; - - The last SOAP request headers. - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/soap/functions/soap-soapclient-getlastresponseheaders.xml b/reference/soap/functions/soap-soapclient-getlastresponseheaders.xml deleted file mode 100644 index a1c58637bb..0000000000 --- a/reference/soap/functions/soap-soapclient-getlastresponseheaders.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - SoapClient->__getLastResponseHeaders - - Returns last SOAP response headers. - - - - &reftitle.description; - - SoapClient - - string - __getLastResponseHeaders - - - - - - This method works only if the SoapClient object - was created with the trace option. - - - - - &reftitle.returnvalues; - - The last SOAP response headers. - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/soap/functions/soap-soapclient-soapcall.xml b/reference/soap/functions/soap-soapclient-soapcall.xml deleted file mode 100644 index 862bf883a6..0000000000 --- a/reference/soap/functions/soap-soapclient-soapcall.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - SoapClient->__soapCall - - Calls a SOAP function - - - - &reftitle.description; - - SoapClient - - mixed__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.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. - - - - &reftitle.examples; - - - SoapClient->__soapCall() Examples - -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; - - - - - - - - is_soap_fault - - - - - - diff --git a/reference/soap/functions/soap-soapserver-fault.xml b/reference/soap/functions/soap-soapserver-fault.xml deleted file mode 100644 index 8b8a1faed3..0000000000 --- a/reference/soap/functions/soap-soapserver-fault.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - SoapServer->fault - Issue SoapServer fault indicating an error - - - &reftitle.description; - - SoapServer - - voidfault - stringcode - stringstring - stringactor - mixeddetails - stringname - - - &warn.undocumented.func; - - - &reftitle.seealso; - - - - - - - - - diff --git a/reference/soap/functions/use-soap-error-handler.xml b/reference/soap/functions/use-soap-error-handler.xml index c39768f4f2..51f0494cbf 100644 --- a/reference/soap/functions/use-soap-error-handler.xml +++ b/reference/soap/functions/use-soap-error-handler.xml @@ -1,18 +1,52 @@ - - - + + + + use_soap_error_handler - Set whether to use the SOAP error handler and return the former value + Set whether to use the SOAP error handler + &reftitle.description; booluse_soap_error_handler - boolhandlertrue + boolhandler - &warn.undocumented.func; + + This function sets whether or not to use the SOAP error handler in the SOAP server. + It will return the previous value. If set to true, details of errors + in a SoapServer application will be sent to the clients. If false, + no information will be sent. + + + + &reftitle.parameters; + + + + handler + + + Set to true to send error details to clients. + + + + + + + + + &reftitle.seealso; + + + set_error_handler + set_exception_handler + + + + + + +
&reftitle.runtime; &extension.runtime; - SOAP Configuration Options + SOAP &ConfigureOptions; - Name - Default - Changeable - Changelog + &Name; + &Default; + &Changeable; + &Changelog; - soap.wsdl_cache_enabled - "1" + soap.wsdl_cache_enabled + 1 PHP_INI_ALL - Available since PHP 5.0.0. + - soap.wsdl_cache_dir - "/tmp" + soap.wsdl_cache_dir + /tmp PHP_INI_ALL - Available since PHP 5.0.0. + - soap.wsdl_cache_ttl - "86400" + soap.wsdl_cache_ttl + 86400 PHP_INI_ALL - Available since PHP 5.0.0. + - soap.wsdl_cache_limit - "5" + soap.wsdl_cache + 1 PHP_INI_ALL - Available since PHP 5.1.5. + - soap.wsdl_cache - "1" + soap.wsdl_cache_limit + 5 PHP_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; + + public voidSoapClient::__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 - - + + public stringSoapClient::__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 - - - + + public voidSoapClient::__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 - - - + + public stringSoapClient::__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; + + public stringSoapClient::__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 - - - + + public stringSoapClient::__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; + + public stringSoapClient::__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 - - - + + public arraySoapClient::__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 - - + + public voidSoapClient::__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 - - + + public stringSoapClient::__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 - - + + public boolSoapClient::__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; + + public mixedSoapClient::__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::fault is_soap_fault + + + + + SoapFault::__toString + Obtain a string representation of a SoapFault + + + + &reftitle.description; + + public voidSoapFault::__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 - - + + public voidSoapServer::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; + + public voidSoapServer::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; + + public voidSoapServer::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 - - - + + public arraySoapServer::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 - - + + public voidSoapServer::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... - - + + public voidSoapServer::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; + + public voidSoapServer::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 - - + + public voidSoapServer::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 +-->