From c35f851d3f12cbe581d78a2d6badbe4c34629233 Mon Sep 17 00:00:00 2001 From: Dave Barr Date: Fri, 27 Feb 2004 13:59:44 +0000 Subject: [PATCH] - Fix typos/grammatical mistakes, and make things a bit easier to read. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@152540 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../soap/functions/SoapClient-SoapClient.xml | 33 ++++++++++--------- .../soap/functions/SoapClient-__call.xml | 20 +++++------ .../functions/SoapClient-__getLastRequest.xml | 5 +-- .../SoapClient-__getLastResponse.xml | 5 +-- .../soap/functions/SoapFault-SoapFault.xml | 9 ++--- .../soap/functions/SoapHeader-SoapHeader.xml | 10 +++--- .../soap/functions/SoapParam-SoapParam.xml | 15 +++++---- .../soap/functions/SoapServer-SoapServer.xml | 8 ++--- .../soap/functions/SoapServer-addFunction.xml | 10 +++--- .../soap/functions/SoapServer-handle.xml | 8 ++--- .../soap/functions/SoapServer-setClass.xml | 8 ++--- .../functions/SoapServer-setPersistence.xml | 7 ++-- reference/soap/functions/SoapVar-SoapVar.xml | 16 ++++----- reference/soap/functions/is-soap-fault.xml | 14 ++++---- 14 files changed, 87 insertions(+), 81 deletions(-) diff --git a/reference/soap/functions/SoapClient-SoapClient.xml b/reference/soap/functions/SoapClient-SoapClient.xml index 1074f5e2fe..db9082d4d1 100644 --- a/reference/soap/functions/SoapClient-SoapClient.xml +++ b/reference/soap/functions/SoapClient-SoapClient.xml @@ -1,5 +1,5 @@ - + SoapClient::SoapClient @@ -15,27 +15,28 @@ arrayoptions - This constructor allows creating SoapClient objects in WSDL or nonWSDL mode. - The first case requires URI of WSDL file as first parameter and an optional - options array. The second case requires &null; as - first parameter and options array with - location and uri options set. - Where location is a URL to request and uri is a target namespace of the SOAP - service. + This constructor allows creating SoapClient objects in WSDL or non-WSDL mode. + The first case requires the URI of WSDL file as the first parameter and an + optional options array. The second case requires &null; + as the first parameter and the options array with + location and uri options set, + where location is a URL to request and uri + is a target namespace of the SOAP service. - style and use options has effect only on - nonWSDL (in WSDL mode they comes from WSDL file). + The style and use options only work in + non-WSDL mode. In WSDL mode, they comes from the WSDL file. - the soap_version option allows to work as SOAP 1.1 or - SOAP 1.2 client. + The soap_version option specifies whether to use SOAP + 1.1, or SOAP 1.2 client. - Some additional options allow using HTTP authentication (login - and password) and HTTP connection through proxy server - (proxy_host, proxy_port, - proxy_login and proxy_password). + For HTTP authentication, you may use the login and + password options. For making a HTTP connection through + a proxy server, use the options proxy_host, + proxy_port, proxy_login + and proxy_password. diff --git a/reference/soap/functions/SoapClient-__call.xml b/reference/soap/functions/SoapClient-__call.xml index 3e9875c9ae..3b7e566bfc 100644 --- a/reference/soap/functions/SoapClient-__call.xml +++ b/reference/soap/functions/SoapClient-__call.xml @@ -1,5 +1,5 @@ - + SoapClient::__call @@ -19,18 +19,18 @@ This is a low level API function to make a SOAP call. Usually in WSDL mode - you can simple call SOAP functions as SoapClient methods. It is useful for - nonWSDL mode when soapaction is unknown, uri - is differ form default or when you like to send and/or receive SOAP Headers. - On error call to SOAP function can cause PHP exceptions or return - SoapFault object, if exceptions was disabled. - To check if function call was failed catch the SoapFault exceptions or - check the result with is_soap_fault function. + you can simply call SOAP functions as SoapClient methods. It is useful for + non-WSDL mode when soapaction is unknown, uri + differs from the default or when you like to send and/or receive SOAP Headers. + On error, a call to a SOAP function can cause PHP exceptions or return a + SoapFault object if exceptions was disabled. + To check if the function call failed catch the SoapFault exceptions or + check the result with the is_soap_fault function. - SOAP function may return one or several values. In the first case it will + SOAP functions may return one or several values. In the first case it will return just the value of output parameter, in the second it will return - associative array with named output parameters. + the associative array with named output parameters. diff --git a/reference/soap/functions/SoapClient-__getLastRequest.xml b/reference/soap/functions/SoapClient-__getLastRequest.xml index f7fbd208aa..4bf1858879 100644 --- a/reference/soap/functions/SoapClient-__getLastRequest.xml +++ b/reference/soap/functions/SoapClient-__getLastRequest.xml @@ -1,5 +1,5 @@ - + SoapClient::__getLastRequest @@ -14,7 +14,8 @@ void - This function works only with SoapClient which was created with trace option. + This function works only with SoapClient which was created with + the trace option. diff --git a/reference/soap/functions/SoapClient-__getLastResponse.xml b/reference/soap/functions/SoapClient-__getLastResponse.xml index 22498bae7a..263e20ec57 100644 --- a/reference/soap/functions/SoapClient-__getLastResponse.xml +++ b/reference/soap/functions/SoapClient-__getLastResponse.xml @@ -1,5 +1,5 @@ - + SoapClient::__getLastResponse @@ -14,7 +14,8 @@ void - This function works only with SoapClient which was created with trace option. + This function works only with SoapClient which was created with + the trace option. diff --git a/reference/soap/functions/SoapFault-SoapFault.xml b/reference/soap/functions/SoapFault-SoapFault.xml index 3eee67e140..eeee527731 100644 --- a/reference/soap/functions/SoapFault-SoapFault.xml +++ b/reference/soap/functions/SoapFault-SoapFault.xml @@ -1,5 +1,5 @@ - + SoapFault::SoapFault @@ -19,13 +19,14 @@ mixedheaderfault - This class is useful when you like to send SOAP fault response from PHP - handler. faultcode, faultstring, + 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; faultname is an optional parameter that can be used to select proper fault encoding from WSDL; headerfault is an optional parameter that - can be used during SOAP header handling to report error in response header. + can be used during SOAP header handling to report an error in the response + header. diff --git a/reference/soap/functions/SoapHeader-SoapHeader.xml b/reference/soap/functions/SoapHeader-SoapHeader.xml index 6f1ea3d584..62c48643a9 100644 --- a/reference/soap/functions/SoapHeader-SoapHeader.xml +++ b/reference/soap/functions/SoapHeader-SoapHeader.xml @@ -1,5 +1,5 @@ - + SoapHeader::SoapHeader @@ -19,10 +19,10 @@ SoapHeader is a special low-level class for passing or returning SOAP - headers. It is just a data holder and it has not any special method - except constructor. It can be used in SoapClient::__call - method to pass SOAP header or in SOAP header handler to return header in - SOAP response. namespace and name + headers. It is just a data holder and it does not have any special methods + except a constructor. It can be used in the SoapClient::__call + method to pass a SOAP header or in a SOAP header handler to return the header in + a SOAP response. namespace and name are namespace and name of the SOAP header element. data is a SOAP header's content. It can be a PHP value or SoapVar object. mustUnderstand and actor are values for diff --git a/reference/soap/functions/SoapParam-SoapParam.xml b/reference/soap/functions/SoapParam-SoapParam.xml index 55740d0661..fcc9b2d89d 100644 --- a/reference/soap/functions/SoapParam-SoapParam.xml +++ b/reference/soap/functions/SoapParam-SoapParam.xml @@ -1,5 +1,5 @@ - + SoapParam::SoapParam @@ -15,12 +15,13 @@ stringname - SoapParam is a special low-level class for naming parameters and return - values in nonWSDL mode. It is just a data holder and it has not any - special method except constructor. The constructor takes data - to pass or return and name. It is possible to pass - parameters directly as PHP value, but in this case it will be named as - paramN and SOAP Service may not understand them. + SoapParam is a special low-level class for naming parameters and return ing + values in non-WSDL mode. It is just a data holder and it does not have any + special methods except the constructor. The constructor takes + data to pass or return and name. + It is possible to pass parameters directly as PHP values, but in this case + it will be named as paramN and the SOAP Service may not + understand them. diff --git a/reference/soap/functions/SoapServer-SoapServer.xml b/reference/soap/functions/SoapServer-SoapServer.xml index 482d8fa42a..5bd3a5a732 100644 --- a/reference/soap/functions/SoapServer-SoapServer.xml +++ b/reference/soap/functions/SoapServer-SoapServer.xml @@ -1,5 +1,5 @@ - + SoapServer::SoapServer @@ -15,9 +15,9 @@ arrayoptions - This constuctor allows creating SoapServer objects in WSDL or nonWSDL mode. - In the first case wsdl must be set to URI of WSDL file. - In the second case, wsdl must be set to &null; and + This constuctor allows the creatiion of SoapServer objects in WSDL or non-WSDL mode. + In the first case, wsdl must be set to the URI of a WSDL file. + In the second case, wsdl must be set to &null; and the uri option must be set. Additional options allow setting a default SOAP version (soap_version) and actor URI (actor). diff --git a/reference/soap/functions/SoapServer-addFunction.xml b/reference/soap/functions/SoapServer-addFunction.xml index 19641c6b92..66c6324a15 100644 --- a/reference/soap/functions/SoapServer-addFunction.xml +++ b/reference/soap/functions/SoapServer-addFunction.xml @@ -1,5 +1,5 @@ - + SoapServer::addFunction @@ -17,16 +17,16 @@ Exports one or more functions for remote clients. - To export one function pass function name into functions - parameter as string. - To export several functions pass an array of function names and to export all + To export one function, pass the function name into the + functions parameter as a string. + To export several functions pass an array of function names, and to export all functions pass a special constant SOAP_FUNCTIONS_ALL. functions must receive all input arguments in the same order as defined in the WSDL file (They should not receive any output parameters as arguments) and return one or more values. To return several values they must - return array with named output parameters. + return an array with named output parameters. diff --git a/reference/soap/functions/SoapServer-handle.xml b/reference/soap/functions/SoapServer-handle.xml index 4279ebb21a..2b5d125679 100644 --- a/reference/soap/functions/SoapServer-handle.xml +++ b/reference/soap/functions/SoapServer-handle.xml @@ -1,5 +1,5 @@ - + SoapServer::handle @@ -14,9 +14,9 @@ stringsoap_request - It processes a SOAP request, call necessary functions, and send response - back. It assumes request in input parameter soap_request - or in global $HTTP_RAW_POST_DATA PHP variable if the argument is + Processes a SOAP request, calls necessary functions, and sends a response + back. It assumes a request in input parameter soap_request + or in the global $HTTP_RAW_POST_DATA PHP variable if the argument is omitted. diff --git a/reference/soap/functions/SoapServer-setClass.xml b/reference/soap/functions/SoapServer-setClass.xml index fab470ae33..4e9e2374ac 100644 --- a/reference/soap/functions/SoapServer-setClass.xml +++ b/reference/soap/functions/SoapServer-setClass.xml @@ -1,5 +1,5 @@ - + SoapServer::setClass @@ -16,9 +16,9 @@ Exports all methods from specified class. Additional parameters args - will be passed to default class constructor during object creation. - The object can be maiden persistent across request for a given PHP session - with SoapServer::setPersistence method. + will be passed to the default class constructor during object creation. + The object can be made persistent across request for a given PHP session + with the SoapServer::setPersistence method. diff --git a/reference/soap/functions/SoapServer-setPersistence.xml b/reference/soap/functions/SoapServer-setPersistence.xml index ddc7052d46..49bbd7f4f4 100644 --- a/reference/soap/functions/SoapServer-setPersistence.xml +++ b/reference/soap/functions/SoapServer-setPersistence.xml @@ -1,5 +1,5 @@ - + SoapServer::setPersistence @@ -14,8 +14,9 @@ intmode - This function allows saving data between requests in PHP session. It works only - with server that exports functions form class with SoapServer::setClass + This function allows saving data between requests in a PHP session. It works only + with a server that exports functions from a class with + SoapServer::setClass. diff --git a/reference/soap/functions/SoapVar-SoapVar.xml b/reference/soap/functions/SoapVar-SoapVar.xml index e61a1d5c98..8e0abc73a4 100644 --- a/reference/soap/functions/SoapVar-SoapVar.xml +++ b/reference/soap/functions/SoapVar-SoapVar.xml @@ -1,5 +1,5 @@ - + SoapVar::SoapVar @@ -19,13 +19,13 @@ stringnode_namespace - SoapVar is a special low-level class for encoding parameters and return - values in nonWSDL mode. It is just a data holder and it has not any - special method except constructor. It is useful when you like to set type - property in SOAP request or response. The constructor takes data - to pass or return, encoding ID to encode it - (see XSD_... constants) and as option type name and - namespace and XML node name and namespace. + SoapVar is a special low-level class for encoding parameters and returning + values in non-WSDL mode. It is just a data holder and does not have any + special methods except the constructor. It is useful when you would like to set + the type property in SOAP request or response. The constructor takes + data to pass or return, encoding + ID to encode it (see XSD_... constants) and as option type + name and namespace and XML node name and namespace. diff --git a/reference/soap/functions/is-soap-fault.xml b/reference/soap/functions/is-soap-fault.xml index 11860ea9c6..f9e591b664 100644 --- a/reference/soap/functions/is-soap-fault.xml +++ b/reference/soap/functions/is-soap-fault.xml @@ -1,5 +1,5 @@ - + is_soap_fault @@ -15,16 +15,16 @@ This function is useful when you like to check if the - SOAP call was failed, but don't like to use exceptions. + SOAP call failed, but don't like to use exceptions. To use it you must create a SoapClient object with - exceptions option set to zero or &false;. - In this case SOAP method will return a special SoapFault - object which encapsulate the fault details (faultcode, + exceptions option set to zero or &false;. + In this case, the SOAP method will return a special SoapFault + object which encapsulates the fault details (faultcode, faultstring, faultactor and faultdetails). - If exceptions is not set then SOAP call will throw an - exception on error. + If exceptions is not set then SOAP call will throw + an exception on error. is_soap_fault checks if the given parameter is a SoapFault object.