sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

- Fix typos/grammatical mistakes, and make things a bit easier to read.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@152540 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Dave Barr 2004-02-27 13:59:44 +00:00
parent f7dd58a66b
commit c35f851d3f
14 changed files with 87 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
reference/soap/functions/SoapClient-SoapClient.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.SoapClient-SoapClient">
<refnamediv>
<refname>SoapClient::SoapClient</refname>
@ -15,27 +15,28 @@
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
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
<parameter>options</parameter> array. The second case requires &null; as
first parameter and <parameter>options</parameter> array with
<literal>location</literal> and <literal>uri</literal> 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 <parameter>options</parameter> array. The second case requires &null;
as the first parameter and the <parameter>options</parameter> array with
<literal>location</literal> and <literal>uri</literal> options set,
where <literal>location</literal> is a URL to request and <literal>uri</literal>
is a target namespace of the SOAP service.
</para>
<para>
<literal>style</literal> and <literal>use</literal> options has effect only on
nonWSDL (in WSDL mode they comes from WSDL file).
The <literal>style</literal> and <literal>use</literal> options only work in
non-WSDL mode. In WSDL mode, they comes from the WSDL file.
</para>
<para>
the <literal>soap_version</literal> option allows to work as SOAP 1.1 or
SOAP 1.2 client.
The <literal>soap_version</literal> option specifies whether to use SOAP
1.1, or SOAP 1.2 client.
</para>
<para>
Some additional options allow using HTTP authentication (<literal>login</literal>
and <literal>password</literal>) and HTTP connection through proxy server
(<literal>proxy_host</literal>, <literal>proxy_port</literal>,
<literal>proxy_login</literal> and <literal>proxy_password</literal>).
For HTTP authentication, you may use the <literal>login</literal> and
<literal>password</literal> options. For making a HTTP connection through
a proxy server, use the options <literal>proxy_host</literal>,
<literal>proxy_port</literal>, <literal>proxy_login</literal>
and <literal>proxy_password</literal>.
</para>
<para>
<example>

20
reference/soap/functions/SoapClient-__call.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.SoapClient-__call">
<refnamediv>
<refname>SoapClient::__call</refname>
@ -19,18 +19,18 @@
</methodsynopsis>
<para>
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 <literal>soapaction</literal> is unknown, <literal>uri</literal>
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 <function>is_soap_fault</function> function.
you can simply call SOAP functions as SoapClient methods. It is useful for
non-WSDL mode when <literal>soapaction</literal> is unknown, <literal>uri</literal>
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 <function>is_soap_fault</function> function.
</para>
<para>
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.
</para>
<para>
<example>

5
reference/soap/functions/SoapClient-__getLastRequest.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.SoapClient-__getLastRequest">
<refnamediv>
<refname>SoapClient::__getLastRequest</refname>
@ -14,7 +14,8 @@
<methodparam><type>void</type><parameter></parameter></methodparam>
</methodsynopsis>
<para>
This function works only with SoapClient which was created with <literal>trace</literal> option.
This function works only with SoapClient which was created with
the <literal>trace</literal> option.
</para>
<para>
<example>

5
reference/soap/functions/SoapClient-__getLastResponse.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.SoapClient-__getLastResponse">
<refnamediv>
<refname>SoapClient::__getLastResponse</refname>
@ -14,7 +14,8 @@
<methodparam><type>void</type><parameter></parameter></methodparam>
</methodsynopsis>
<para>
This function works only with SoapClient which was created with <literal>trace</literal> option.
This function works only with SoapClient which was created with
the <literal>trace</literal> option.
</para>
<para>
<example>

9
reference/soap/functions/SoapFault-SoapFault.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.SoapFault-SoapFault">
<refnamediv>
<refname>SoapFault::SoapFault</refname>
@ -19,13 +19,14 @@
<methodparam choice="opt"><type>mixed</type><parameter>headerfault</parameter></methodparam>
</methodsynopsis>
<para>
This class is useful when you like to send SOAP fault response from PHP
handler. <parameter>faultcode</parameter>, <parameter>faultstring</parameter>,
This class is useful when you would like to send SOAP fault responses from
the PHP handler. <parameter>faultcode</parameter>, <parameter>faultstring</parameter>,
<parameter>faultactor</parameter> and <parameter>details</parameter> are
standard elements of SOAP Fault; <parameter>faultname</parameter> is an
optional parameter that can be used to select proper fault encoding from
WSDL; <parameter>headerfault</parameter> 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.
</para>
<para>
<example>

10
reference/soap/functions/SoapHeader-SoapHeader.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.SoapHeader-SoapHeader">
<refnamediv>
<refname>SoapHeader::SoapHeader</refname>
@ -19,10 +19,10 @@
</methodsynopsis>
<para>
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 <function>SoapClient::__call</function>
method to pass SOAP header or in SOAP header handler to return header in
SOAP response. <parameter>namespace</parameter> and <parameter>name</parameter>
headers. It is just a data holder and it does not have any special methods
except a constructor. It can be used in the <function>SoapClient::__call</function>
method to pass a SOAP header or in a SOAP header handler to return the header in
a SOAP response. <parameter>namespace</parameter> and <parameter>name</parameter>
are namespace and name of the SOAP header element. <parameter>data</parameter> is a SOAP
header's content. It can be a PHP value or SoapVar object.
<parameter>mustUnderstand</parameter> and <parameter>actor</parameter> are values for

15
reference/soap/functions/SoapParam-SoapParam.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.SoapParam-SoapParam">
<refnamediv>
<refname>SoapParam::SoapParam</refname>
@ -15,12 +15,13 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
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 <parameter>data</parameter>
to pass or return and <parameter>name</parameter>. It is possible to pass
parameters directly as PHP value, but in this case it will be named as
<literal>paramN</literal> 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
<parameter>data</parameter> to pass or return and <parameter>name</parameter>.
It is possible to pass parameters directly as PHP values, but in this case
it will be named as <literal>paramN</literal> and the SOAP Service may not
understand them.
</para>
<para>
<example>

8
reference/soap/functions/SoapServer-SoapServer.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.SoapServer-SoapServer">
<refnamediv>
<refname>SoapServer::SoapServer</refname>
@ -15,9 +15,9 @@
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This constuctor allows creating SoapServer objects in WSDL or nonWSDL mode.
In the first case <parameter>wsdl</parameter> must be set to URI of WSDL file.
In the second case, <parameter>wsdl</parameter> must be set to &null; and
This constuctor allows the creatiion of SoapServer objects in WSDL or non-WSDL mode.
In the first case, <parameter>wsdl</parameter> must be set to the URI of a WSDL file.
In the second case, <parameter>wsdl</parameter> must be set to &null; and the
<literal>uri</literal> option must be set.
Additional <parameter>options</parameter> allow setting a default SOAP version
(<literal>soap_version</literal>) and actor URI (<literal>actor</literal>).

10
reference/soap/functions/SoapServer-addFunction.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.SoapServer-addFunction">
<refnamediv>
<refname>SoapServer::addFunction</refname>
@ -17,16 +17,16 @@
Exports one or more functions for remote clients.
</para>
<para>
To export one function pass function name into <parameter>functions</parameter>
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
<parameter>functions</parameter> parameter as a string.
To export several functions pass an array of function names, and to export all
functions pass a special constant <constant>SOAP_FUNCTIONS_ALL</constant>.
</para>
<para>
<parameter>functions</parameter> 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.
</para>
<para>
<example>

8
reference/soap/functions/SoapServer-handle.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.SoapServer-handle">
<refnamediv>
<refname>SoapServer::handle</refname>
@ -14,9 +14,9 @@
<methodparam choice="opt"><type>string</type><parameter>soap_request</parameter></methodparam>
</methodsynopsis>
<para>
It processes a SOAP request, call necessary functions, and send response
back. It assumes request in input parameter <parameter>soap_request</parameter>
or in global <varname>$HTTP_RAW_POST_DATA</varname> 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 <parameter>soap_request</parameter>
or in the global <varname>$HTTP_RAW_POST_DATA</varname> PHP variable if the argument is
omitted.
</para>
<para>

8
reference/soap/functions/SoapServer-setClass.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.SoapServer-setClass">
<refnamediv>
<refname>SoapServer::setClass</refname>
@ -16,9 +16,9 @@
</methodsynopsis>
<para>
Exports all methods from specified class. Additional parameters <parameter>args</parameter>
will be passed to default class constructor during object creation.
The object can be maiden persistent across request for a given PHP session
with <function>SoapServer::setPersistence</function> 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 <function>SoapServer::setPersistence</function> method.
</para>
<para>
<example>

7
reference/soap/functions/SoapServer-setPersistence.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.SoapServer-setPersistence">
<refnamediv>
<refname>SoapServer::setPersistence</refname>
@ -14,8 +14,9 @@
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
This function allows saving data between requests in PHP session. It works only
with server that exports functions form class with <function>SoapServer::setClass</function>
This function allows saving data between requests in a PHP session. It works only
with a server that exports functions from a class with
<function>SoapServer::setClass</function>.
</para>
<para>
<example>

16
reference/soap/functions/SoapVar-SoapVar.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.SoapVar-SoapVar">
<refnamediv>
<refname>SoapVar::SoapVar</refname>
@ -19,13 +19,13 @@
<methodparam choice="opt"><type>string</type><parameter>node_namespace</parameter></methodparam>
</methodsynopsis>
<para>
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 <parameter>data</parameter>
to pass or return, <parameter>encoding</parameter> ID to encode it
(see <literal>XSD_...</literal> 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
<parameter>data</parameter> to pass or return, <parameter>encoding</parameter>
ID to encode it (see <literal>XSD_...</literal> constants) and as option type
name and namespace and XML node name and namespace.
</para>
<para>
<example>

14
reference/soap/functions/is-soap-fault.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.is-soap-fault">
<refnamediv>
<refname>is_soap_fault</refname>
@ -15,16 +15,16 @@
</methodsynopsis>
<para>
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,
<literal>exceptions</literal> 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).
</para>
<para>
If exceptions is not set then SOAP call will throw an
exception on error.
If <literal>exceptions</literal> is not set then SOAP call will throw
an exception on error.
<function>is_soap_fault</function> checks if the given
parameter is a SoapFault object.
</para>