php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove PHP4 constructors from ext/soap documentation

Browse Source 
Contructors were still documented as aliases to classname::classname
 with the real documentation in classname::classname.

Closes GH-332.
This commit is contained in:
Côme Chilliet
2021-01-14 10:52:05 +01:00
committed by Christoph M. Becker
parent 572c672502
commit e64ea89bbe
22 changed files with 693 additions and 958 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
reference/soap/functions/is-soap-fault.xml
View File

@@ -15,11 +15,11 @@
</methodsynopsis>
<para>
This function is useful to check if the SOAP call failed, but
without using exceptions. To use it, create a
without using exceptions. To use it, create a
<classname>SoapClient</classname> object with the <literal>exceptions</literal>
option set to zero or &false;.
In this case, the SOAP method will return a special
<classname>SoapFault</classname> object which encapsulates the fault
In this case, the SOAP method will return a special
<classname>SoapFault</classname> object which encapsulates the fault
details (faultcode, faultstring, faultactor and faultdetails).
</para>
<para>
@@ -93,8 +93,8 @@ try {
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::SoapClient</methodname></member>
<member><methodname>SoapFault::SoapFault</methodname></member>
<member><methodname>SoapClient::__construct</methodname></member>
<member><methodname>SoapFault::__construct</methodname></member>
</simplelist>
</para>
</refsect1>

212
reference/soap/soapclient/construct.xml
View File

@@ -14,11 +14,221 @@
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</constructorsynopsis>
<para>
&info.function.alias; <methodname>SoapClient::SoapClient</methodname>
This constructor creates <classname>SoapClient</classname> objects
in <literal>WSDL</literal> or <literal>non-WSDL</literal> mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>wsdl</parameter></term>
<listitem>
<para>
URI of the <literal>WSDL</literal> file or &null; if working in
<literal>non-WSDL</literal> mode.
</para>
<note>
<para>
During development, WSDL caching may be disabled by the
use of the <literal>soap.wsdl_cache_ttl</literal> &php.ini; setting
otherwise changes made to the WSDL file will have no effect until
<literal>soap.wsdl_cache_ttl</literal> is expired.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An array of options. If working in WSDL mode, this parameter is optional.
If working in non-WSDL mode, the <literal>location</literal> and
<literal>uri</literal> options must be set, where <literal>location</literal>
is the URL of the SOAP server to send the request to, and <literal>uri</literal>
is the target namespace of the SOAP service.
</para>
<para>
The <literal>style</literal> and <literal>use</literal> options only work in
non-WSDL mode. In WSDL mode, they come from the WSDL file.
</para>
<para>
The <literal>soap_version</literal> option should be one of either
<constant>SOAP_1_1</constant> or <constant>SOAP_1_2</constant> to
select SOAP 1.1 or 1.2, respectively. If omitted, 1.1 is used.
</para>
<para>
For HTTP authentication, the <literal>login</literal> and
<literal>password</literal> options can be used to supply credentials.
For making an HTTP connection through
a proxy server, the options <literal>proxy_host</literal>,
<literal>proxy_port</literal>, <literal>proxy_login</literal>
and <literal>proxy_password</literal> are also available.
For HTTPS client certificate authentication use
<literal>local_cert</literal> and <literal>passphrase</literal> options. An
authentication may be supplied in the <literal>authentication</literal>
option. The authentication method may be either
<constant>SOAP_AUTHENTICATION_BASIC</constant> (default) or
<constant>SOAP_AUTHENTICATION_DIGEST</constant>.
</para>
<para>
The <literal>compression</literal> option allows to use compression
of HTTP SOAP requests and responses.
</para>
<para>
The <literal>encoding</literal> option defines internal character
encoding. This option does not change the encoding of SOAP requests (it is
always utf-8), but converts strings into it.
</para>
<para>
The <literal>trace</literal> option enables tracing of request so faults
can be backtraced. This defaults to &false;
</para>
<para>
The <literal>classmap</literal> option can be used to map some WSDL
types to PHP classes. This option must be an array with WSDL types
as keys and names of PHP classes as values.
</para>
<para>
Setting the boolean <literal>trace</literal> option enables use of the
methods <link linkend="soapclient.getlastrequest">
SoapClient->__getLastRequest</link>,
<link linkend="soapclient.getlastrequestheaders">
SoapClient->__getLastRequestHeaders</link>,
<link linkend="soapclient.getlastresponse">
SoapClient->__getLastResponse</link> and
<link linkend="soapclient.getlastresponseheaders">
SoapClient->__getLastResponseHeaders</link>.
</para>
<para>
The <literal>exceptions</literal> option is a boolean value defining whether
soap errors throw exceptions of type <link
linkend="soapfault.construct">
SoapFault</link>.
</para>
<para>
The <literal>connection_timeout</literal> option defines a timeout in seconds
for the connection to the SOAP service. This option does not define a timeout
for services with slow responses. To limit the time to wait for calls to finish the
<link linkend="ini.default-socket-timeout">default_socket_timeout</link> setting
is available.
</para>
<para>
The <literal>typemap</literal> option is an array of type mappings.
Type mapping is an array with keys <literal>type_name</literal>,
<literal>type_ns</literal> (namespace URI), <literal>from_xml</literal>
(callback accepting one string parameter) and <literal>to_xml</literal>
(callback accepting one object parameter).
</para>
<para>
The <literal>cache_wsdl</literal> option is one of
<constant>WSDL_CACHE_NONE</constant>,
<constant>WSDL_CACHE_DISK</constant>,
<constant>WSDL_CACHE_MEMORY</constant> or
<constant>WSDL_CACHE_BOTH</constant>.
</para>
<para>
The <literal>user_agent</literal> option specifies string to use in
<literal>User-Agent</literal> header.
</para>
<para>
The <literal>stream_context</literal> option is a <type>resource</type>
for <link linkend="context">context</link>.
</para>
<para>
The <literal>features</literal> option is a bitmask of
<constant>SOAP_SINGLE_ELEMENT_ARRAYS</constant>,
<constant>SOAP_USE_XSI_ARRAY_TYPE</constant>,
<constant>SOAP_WAIT_ONE_WAY_CALLS</constant>.
</para>
<para>
The <literal>keep_alive</literal> option is a boolean value defining whether
to send the <literal>Connection: Keep-Alive</literal> header or
<literal>Connection: close</literal>.
</para>
<para>
The <literal>ssl_method</literal> option is one of
<constant>SOAP_SSL_METHOD_TLS</constant>,
<constant>SOAP_SSL_METHOD_SSLv2</constant>,
<constant>SOAP_SSL_METHOD_SSLv3</constant> or
<constant>SOAP_SSL_METHOD_SSLv23</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<methodname>SoapClient::__construct</methodname> will generate an
<constant>E_ERROR</constant> error if the <literal>location</literal> and
<literal>uri</literal> options aren't provided in non-WSDL mode.
</para>
<para>
A <classname>SoapFault</classname> exception will be thrown if the
<parameter>wsdl</parameter> URI cannot be loaded.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapClient::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient("some.wsdl");
$client = new SoapClient("some.wsdl", array('soap_version' => SOAP_1_2));
$client = new SoapClient("some.wsdl", array('login' => "some_name",
'password' => "some_password"));
$client = new SoapClient("some.wsdl", array('proxy_host' => "localhost",
'proxy_port' => 8080));
$client = new SoapClient("some.wsdl", array('proxy_host' => "localhost",
'proxy_port' => 8080,
'proxy_login' => "some_name",
'proxy_password' => "some_password"));
$client = new SoapClient("some.wsdl", array('local_cert' => "cert_key.pem"));
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/",
'style' => SOAP_DOCUMENT,
'use' => SOAP_LITERAL));
$client = new SoapClient("some.wsdl",
array('compression' => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP));
$client = new SoapClient("some.wsdl", array('encoding'=>'ISO-8859-1'));
class MyBook {
public $title;
public $author;
}
$client = new SoapClient("books.wsdl", array('classmap' => array('book' => "MyBook")));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

2
reference/soap/soapclient/getfunctions.xml
View File

@@ -72,7 +72,7 @@ array(26) {
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::SoapClient</methodname></member>
<member><methodname>SoapClient::__construct</methodname></member>
</simplelist>
</para>
</refsect1>

2
reference/soap/soapclient/gettypes.xml
View File

@@ -88,7 +88,7 @@ array(88) {
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::SoapClient</methodname></member>
<member><methodname>SoapClient::__construct</methodname></member>
</simplelist>
</para>
</refsect1>

4
reference/soap/soapclient/setlocation.xml
View File

@@ -13,7 +13,7 @@
<methodparam choice="opt"><type>string</type><parameter>location</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Sets the endpoint URL that will be touched by following SOAP requests. This is equivalent to
Sets the endpoint URL that will be touched by following SOAP requests. This is equivalent to
specifying the <literal>location</literal> option when constructing the SoapClient.
</para>
<note>
@@ -80,7 +80,7 @@ http://www.somethirdparty.com
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::SoapClient</methodname></member>
<member><methodname>SoapClient::__construct</methodname></member>
</simplelist>
</para>
</refsect1>

10
reference/soap/soapclient/soapcall.xml
View File

@@ -141,11 +141,11 @@ $client->__soapCall("SomeFunction", array($a, $b, $c),
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::SoapClient</methodname></member>
<member><methodname>SoapParam::SoapParam</methodname></member>
<member><methodname>SoapVar::SoapVar</methodname></member>
<member><methodname>SoapHeader::SoapHeader</methodname></member>
<member><methodname>SoapFault::SoapFault</methodname></member>
<member><methodname>SoapClient::__construct</methodname></member>
<member><methodname>SoapParam::__construct</methodname></member>
<member><methodname>SoapVar::__construct</methodname></member>
<member><methodname>SoapHeader::__construct</methodname></member>
<member><methodname>SoapFault::__construct</methodname></member>
<member><function>is_soap_fault</function></member>
</simplelist>
</para>

252
reference/soap/soapclient/soapclient.xml
View File

@@ -1,252 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="soapclient.soapclient" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient::SoapClient</refname>
<refpurpose>SoapClient constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>SoapClient::SoapClient</methodname>
<methodparam><type>mixed</type><parameter>wsdl</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This constructor creates <classname>SoapClient</classname> objects
in <literal>WSDL</literal> or <literal>non-WSDL</literal> mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>wsdl</parameter></term>
<listitem>
<para>
URI of the <literal>WSDL</literal> file or &null; if working in
<literal>non-WSDL</literal> mode.
</para>
<note>
<para>
During development, WSDL caching may be disabled by the
use of the <literal>soap.wsdl_cache_ttl</literal> &php.ini; setting
otherwise changes made to the WSDL file will have no effect until
<literal>soap.wsdl_cache_ttl</literal> is expired.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An array of options. If working in WSDL mode, this parameter is optional.
If working in non-WSDL mode, the <literal>location</literal> and
<literal>uri</literal> options must be set, where <literal>location</literal>
is the URL of the SOAP server to send the request to, and <literal>uri</literal>
is the target namespace of the SOAP service.
</para>
<para>
The <literal>style</literal> and <literal>use</literal> options only work in
non-WSDL mode. In WSDL mode, they come from the WSDL file.
</para>
<para>
The <literal>soap_version</literal> option should be one of either
<constant>SOAP_1_1</constant> or <constant>SOAP_1_2</constant> to
select SOAP 1.1 or 1.2, respectively. If omitted, 1.1 is used.
</para>
<para>
For HTTP authentication, the <literal>login</literal> and
<literal>password</literal> options can be used to supply credentials.
For making an HTTP connection through
a proxy server, the options <literal>proxy_host</literal>,
<literal>proxy_port</literal>, <literal>proxy_login</literal>
and <literal>proxy_password</literal> are also available.
For HTTPS client certificate authentication use
<literal>local_cert</literal> and <literal>passphrase</literal> options. An
authentication may be supplied in the <literal>authentication</literal>
option. The authentication method may be either
<constant>SOAP_AUTHENTICATION_BASIC</constant> (default) or
<constant>SOAP_AUTHENTICATION_DIGEST</constant>.
</para>
<para>
The <literal>compression</literal> option allows to use compression
of HTTP SOAP requests and responses.
</para>
<para>
The <literal>encoding</literal> option defines internal character
encoding. This option does not change the encoding of SOAP requests (it is
always utf-8), but converts strings into it.
</para>
<para>
The <literal>trace</literal> option enables tracing of request so faults
can be backtraced. This defaults to &false;
</para>
<para>
The <literal>classmap</literal> option can be used to map some WSDL
types to PHP classes. This option must be an array with WSDL types
as keys and names of PHP classes as values.
</para>
<para>
Setting the boolean <literal>trace</literal> option enables use of the
methods <link linkend="soapclient.getlastrequest">
SoapClient->__getLastRequest</link>,
<link linkend="soapclient.getlastrequestheaders">
SoapClient->__getLastRequestHeaders</link>,
<link linkend="soapclient.getlastresponse">
SoapClient->__getLastResponse</link> and
<link linkend="soapclient.getlastresponseheaders">
SoapClient->__getLastResponseHeaders</link>.
</para>
<para>
The <literal>exceptions</literal> option is a boolean value defining whether
soap errors throw exceptions of type <link
linkend="soapfault.soapfault">
SoapFault</link>.
</para>
<para>
The <literal>connection_timeout</literal> option defines a timeout in seconds
for the connection to the SOAP service. This option does not define a timeout
for services with slow responses. To limit the time to wait for calls to finish the
<link linkend="ini.default-socket-timeout">default_socket_timeout</link> setting
is available.
</para>
<para>
The <literal>typemap</literal> option is an array of type mappings.
Type mapping is an array with keys <literal>type_name</literal>,
<literal>type_ns</literal> (namespace URI), <literal>from_xml</literal>
(callback accepting one string parameter) and <literal>to_xml</literal>
(callback accepting one object parameter).
</para>
<para>
The <literal>cache_wsdl</literal> option is one of
<constant>WSDL_CACHE_NONE</constant>,
<constant>WSDL_CACHE_DISK</constant>,
<constant>WSDL_CACHE_MEMORY</constant> or
<constant>WSDL_CACHE_BOTH</constant>.
</para>
<para>
The <literal>user_agent</literal> option specifies string to use in
<literal>User-Agent</literal> header.
</para>
<para>
The <literal>stream_context</literal> option is a <type>resource</type>
for <link linkend="context">context</link>.
</para>
<para>
The <literal>features</literal> option is a bitmask of
<constant>SOAP_SINGLE_ELEMENT_ARRAYS</constant>,
<constant>SOAP_USE_XSI_ARRAY_TYPE</constant>,
<constant>SOAP_WAIT_ONE_WAY_CALLS</constant>.
</para>
<para>
The <literal>keep_alive</literal> option is a boolean value defining whether
to send the <literal>Connection: Keep-Alive</literal> header or
<literal>Connection: close</literal>.
</para>
<para>
The <literal>ssl_method</literal> option is one of
<constant>SOAP_SSL_METHOD_TLS</constant>,
<constant>SOAP_SSL_METHOD_SSLv2</constant>,
<constant>SOAP_SSL_METHOD_SSLv3</constant> or
<constant>SOAP_SSL_METHOD_SSLv23</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<methodname>SoapClient::SoapClient</methodname> will generate an
<constant>E_ERROR</constant> error if the <literal>location</literal> and
<literal>uri</literal> options aren't provided in non-WSDL mode.
</para>
<para>
A <classname>SoapFault</classname> exception will be thrown if the
<parameter>wsdl</parameter> URI cannot be loaded.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapClient::SoapClient</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient("some.wsdl");
$client = new SoapClient("some.wsdl", array('soap_version' => SOAP_1_2));
$client = new SoapClient("some.wsdl", array('login' => "some_name",
'password' => "some_password"));
$client = new SoapClient("some.wsdl", array('proxy_host' => "localhost",
'proxy_port' => 8080));
$client = new SoapClient("some.wsdl", array('proxy_host' => "localhost",
'proxy_port' => 8080,
'proxy_login' => "some_name",
'proxy_password' => "some_password"));
$client = new SoapClient("some.wsdl", array('local_cert' => "cert_key.pem"));
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/",
'style' => SOAP_DOCUMENT,
'use' => SOAP_LITERAL));
$client = new SoapClient("some.wsdl",
array('compression' => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP));
$client = new SoapClient("some.wsdl", array('encoding'=>'ISO-8859-1'));
class MyBook {
public $title;
public $author;
}
$client = new SoapClient("books.wsdl", array('classmap' => array('book' => "MyBook")));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

117
reference/soap/soapfault/construct.xml
View File

@@ -18,12 +18,127 @@
<methodparam choice="opt"><type>mixed</type><parameter>headerFault</parameter><initializer>&null;</initializer></methodparam>
</constructorsynopsis>
<para>
&info.function.alias; <methodname>SoapFault::SoapFault</methodname>
This class is used to send SOAP fault responses from the PHP handler.
<parameter>faultcode</parameter>, <parameter>faultstring</parameter>,
<parameter>faultactor</parameter> and <parameter>detail</parameter> are
standard elements of a SOAP Fault.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>faultcode</parameter></term>
<listitem>
<para>
The error code of the <classname>SoapFault</classname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>faultstring</parameter></term>
<listitem>
<para>
The error message of the <classname>SoapFault</classname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>faultactor</parameter></term>
<listitem>
<para>
A string identifying the actor that caused the error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>detail</parameter></term>
<listitem>
<para>
More details about the cause of the error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>faultname</parameter></term>
<listitem>
<para>
Can be used to select the proper fault encoding from WSDL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>headerfault</parameter></term>
<listitem>
<para>
Can be used during SOAP header handling to report an error in the
response header.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<programlisting role="php">
<![CDATA[
<?php
function test($x)
{
return new SoapFault("Server", "Some error message");
}
$server = new SoapServer(null, array('uri' => "http://test-uri/"));
$server->addFunction("test");
$server->handle();
?>
]]>
</programlisting>
</example>
</para>
<para>
It is possible to use PHP exception mechanism to throw SOAP Fault.
</para>
<para>
<example>
<title>Some examples</title>
<programlisting role="php">
<![CDATA[
<?php
function test($x)
{
throw new SoapFault("Server", "Some error message");
}
$server = new SoapServer(null, array('uri' => "http://test-uri/"));
$server->addFunction("test");
$server->handle();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapServer::fault</methodname></member>
<member><function>is_soap_fault</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

162
reference/soap/soapfault/soapfault.xml
View File

@@ -1,162 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="soapfault.soapfault" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapFault::SoapFault</refname>
<refpurpose>SoapFault constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>SoapFault::SoapFault</methodname>
<methodparam><type>string</type><parameter>faultcode</parameter></methodparam>
<methodparam><type>string</type><parameter>faultstring</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>faultactor</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>detail</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>faultname</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>headerfault</parameter></methodparam>
</methodsynopsis>
<para>
This class is used to send SOAP fault responses from the PHP handler.
<parameter>faultcode</parameter>, <parameter>faultstring</parameter>,
<parameter>faultactor</parameter> and <parameter>detail</parameter> are
standard elements of a SOAP Fault.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>faultcode</parameter></term>
<listitem>
<para>
The error code of the <classname>SoapFault</classname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>faultstring</parameter></term>
<listitem>
<para>
The error message of the <classname>SoapFault</classname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>faultactor</parameter></term>
<listitem>
<para>
A string identifying the actor that caused the error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>detail</parameter></term>
<listitem>
<para>
More details about the cause of the error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>faultname</parameter></term>
<listitem>
<para>
Can be used to select the proper fault encoding from WSDL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>headerfault</parameter></term>
<listitem>
<para>
Can be used during SOAP header handling to report an error in the
response header.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<programlisting role="php">
<![CDATA[
<?php
function test($x)
{
return new SoapFault("Server", "Some error message");
}
$server = new SoapServer(null, array('uri' => "http://test-uri/"));
$server->addFunction("test");
$server->handle();
?>
]]>
</programlisting>
</example>
</para>
<para>
It is possible to use PHP exception mechanism to throw SOAP Fault.
</para>
<para>
<example>
<title>Some examples</title>
<programlisting role="php">
<![CDATA[
<?php
function test($x)
{
throw new SoapFault("Server", "Some error message");
}
$server = new SoapServer(null, array('uri' => "http://test-uri/"));
$server->addFunction("test");
$server->handle();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapServer::fault</methodname></member>
<member><function>is_soap_fault</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

86
reference/soap/soapheader/construct.xml
View File

@@ -18,7 +18,91 @@
<methodparam choice="opt"><type>string</type><parameter>actor</parameter></methodparam>
</constructorsynopsis>
<para>
&info.function.alias; <methodname>SoapHeader::SoapHeader</methodname>
Constructs a new SoapHeader object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>namespace</parameter></term>
<listitem>
<para>
The namespace of the SOAP header element.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the SoapHeader object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
A SOAP header's content. It can be a PHP value or a
<classname>SoapVar</classname> object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mustUnderstand</parameter></term>
<listitem>
<para>
Value of the <literal>mustUnderstand</literal> attribute of the SOAP
header element.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>actor</parameter></term>
<listitem>
<para>
Value of the <literal>actor</literal> attribute of the SOAP header
element.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapHeader::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$client->__soapCall("echoVoid", null, null,
new SoapHeader('http://soapinterop.org/echoheader/',
'echoMeStringRequest',
'hello world'));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__soapCall</methodname></member>
<member><methodname>SoapVar::__construct</methodname></member>
<member><methodname>SoapParam::__construct</methodname></member>
<member><methodname>SoapServer::addSoapHeader</methodname></member>
</simplelist>
</para>
</refsect1>

130
reference/soap/soapheader/soapheader.xml
View File

@@ -1,130 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="soapheader.soapheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapHeader::SoapHeader</refname>
<refpurpose>SoapHeader constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>SoapHeader::SoapHeader</methodname>
<methodparam><type>string</type><parameter>namespace</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>mustunderstand</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>actor</parameter></methodparam>
</methodsynopsis>
<para>
Constructs a new SoapHeader object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>namespace</parameter></term>
<listitem>
<para>
The namespace of the SOAP header element.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the SoapHeader object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
A SOAP header's content. It can be a PHP value or a
<classname>SoapVar</classname> object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mustUnderstand</parameter></term>
<listitem>
<para>
Value of the <literal>mustUnderstand</literal> attribute of the SOAP
header element.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>actor</parameter></term>
<listitem>
<para>
Value of the <literal>actor</literal> attribute of the SOAP header
element.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapHeader::SoapHeader</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$client->__soapCall("echoVoid", null, null,
new SoapHeader('http://soapinterop.org/echoheader/',
'echoMeStringRequest',
'hello world'));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__soapCall</methodname></member>
<member><methodname>SoapVar::SoapVar</methodname></member>
<member><methodname>SoapParam::SoapParam</methodname></member>
<member><methodname>SoapServer::addSoapHeader</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

59
reference/soap/soapparam/construct.xml
View File

@@ -14,11 +14,68 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</constructorsynopsis>
<para>
&info.function.alias; <methodname>SoapParam::SoapParam</methodname>
Constructs a new <classname>SoapParam</classname> object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The data to pass or return. This parameter can be passed directly as PHP
value, but in this case it will be named as <literal>paramN</literal> and
the SOAP service may not understand it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The parameter name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapParam::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient(null,array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$client->SomeFunction(new SoapParam($a, "a"),
new SoapParam($b, "b"),
new SoapParam($c, "c"));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__soapCall</methodname></member>
<member><methodname>SoapVar::__construct</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

99
reference/soap/soapparam/soapparam.xml
View File

@@ -1,99 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="soapparam.soapparam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapParam::SoapParam</refname>
<refpurpose>SoapParam constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>SoapParam::SoapParam</methodname>
<methodparam><type>mixed</type><parameter>data</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Constructs a new <classname>SoapParam</classname> object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The data to pass or return. This parameter can be passed directly as PHP
value, but in this case it will be named as <literal>paramN</literal> and
the SOAP service may not understand it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The parameter name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapParam::SoapParam</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient(null,array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$client->SomeFunction(new SoapParam($a, "a"),
new SoapParam($b, "b"),
new SoapParam($c, "c"));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__soapCall</methodname></member>
<member><methodname>SoapVar::SoapVar</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

2
reference/soap/soapserver/addfunction.xml
View File

@@ -91,7 +91,7 @@ $server->addFunction(SOAP_FUNCTIONS_ALL);
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapServer::SoapServer</methodname></member>
<member><methodname>SoapServer::__construct</methodname></member>
<member><methodname>SoapServer::setClass</methodname></member>
</simplelist>
</para>

104
reference/soap/soapserver/construct.xml
View File

@@ -14,11 +14,113 @@
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</constructorsynopsis>
<para>
&info.function.alias; <methodname>SoapServer::SoapServer</methodname>
This constructor allows the creation of <classname>SoapServer</classname>
objects in WSDL or non-WSDL mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>wsdl</parameter></term>
<listitem>
<para>
To use the SoapServer in WSDL mode, pass the URI of a WSDL file.
Otherwise, pass &null; and set the <literal>uri</literal> option to the
target namespace for the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Allow setting a default SOAP version (<literal>soap_version</literal>),
internal character encoding (<literal>encoding</literal>),
and actor URI (<literal>actor</literal>).
</para>
<para>
The <literal>classmap</literal> option can be used to map some WSDL
types to PHP classes. This option must be an array with WSDL types
as keys and names of PHP classes as values.
</para>
<para>
The <literal>typemap</literal> option is an array of type mappings.
Type mapping is an array with keys <literal>type_name</literal>,
<literal>type_ns</literal> (namespace URI), <literal>from_xml</literal>
(callback accepting one string parameter) and <literal>to_xml</literal>
(callback accepting one object parameter).
</para>
<para>
The <literal>cache_wsdl</literal> option is one of
<constant>WSDL_CACHE_NONE</constant>,
<constant>WSDL_CACHE_DISK</constant>,
<constant>WSDL_CACHE_MEMORY</constant> or
<constant>WSDL_CACHE_BOTH</constant>.
</para>
<para>
There is also a <literal>features</literal> option which can be set to
<constant>SOAP_WAIT_ONE_WAY_CALLS</constant>,
<constant>SOAP_SINGLE_ELEMENT_ARRAYS</constant>,
<constant>SOAP_USE_XSI_ARRAY_TYPE</constant>.
</para>
<para>
The <literal>send_errors</literal> option can be set to &false; to sent a
generic error message ("Internal error") instead of the specific error
message sent otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapServer::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$server = new SoapServer("some.wsdl");
$server = new SoapServer("some.wsdl", array('soap_version' => SOAP_1_2));
$server = new SoapServer("some.wsdl", array('actor' => "http://example.org/ts-tests/C"));
$server = new SoapServer("some.wsdl", array('encoding'=>'ISO-8859-1'));
$server = new SoapServer(null, array('uri' => "http://test-uri/"));
class MyBook {
public $title;
public $author;
}
$server = new SoapServer("books.wsdl", array('classmap' => array('book' => "MyBook")));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__construct</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

2
reference/soap/soapserver/fault.xml
View File

@@ -85,7 +85,7 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapFault::SoapFault</methodname></member>
<member><methodname>SoapFault::__construct</methodname></member>
</simplelist>
</para>
</refsect1>

6
reference/soap/soapserver/getfunctions.xml
View File

@@ -15,8 +15,8 @@
</methodsynopsis>
<para>
Returns a list of the defined functions in the SoapServer object.
This method returns the list of all functions added by
<methodname>SoapServer::addFunction</methodname> or
This method returns the list of all functions added by
<methodname>SoapServer::addFunction</methodname> or
<methodname>SoapServer::setClass</methodname>.
</para>
</refsect1>
@@ -63,7 +63,7 @@ if ($_SERVER["REQUEST_METHOD"] == "POST") {
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapServer::SoapServer</methodname></member>
<member><methodname>SoapServer::__construct</methodname></member>
<member><methodname>SoapServer::addFunction</methodname></member>
<member><methodname>SoapServer::setClass</methodname></member>
</simplelist>

4
reference/soap/soapserver/handle.xml
View File

@@ -13,7 +13,7 @@
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>request</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Processes a SOAP request, calls necessary functions, and sends a response
Processes a SOAP request, calls necessary functions, and sends a response
back.
</para>
</refsect1>
@@ -91,7 +91,7 @@ $server->handle();
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapServer::SoapServer</methodname></member>
<member><methodname>SoapServer::__construct</methodname></member>
</simplelist>
</para>
</refsect1>

6
reference/soap/soapserver/setclass.xml
View File

@@ -17,7 +17,7 @@
Exports all methods from specified class.
</para>
<para>
The object can be made persistent across request for a given PHP session
The object can be made persistent across request for a given PHP session
with the <methodname>SoapServer::setPersistence</methodname> method.
</para>
</refsect1>
@@ -39,7 +39,7 @@
<listitem>
<para>
These optional parameters will be passed to the default class constructor
during object creation.
during object creation.
</para>
</listitem>
</varlistentry>
@@ -58,7 +58,7 @@
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapServer::SoapServer</methodname></member>
<member><methodname>SoapServer::__construct</methodname></member>
<member><methodname>SoapServer::addFunction</methodname></member>
<member><methodname>SoapServer::setPersistence</methodname></member>
</simplelist>

144
reference/soap/soapserver/soapserver.xml
View File

@@ -1,144 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="soapserver.soapserver" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer::SoapServer</refname>
<refpurpose>SoapServer constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>SoapServer::SoapServer</methodname>
<methodparam><type>mixed</type><parameter>wsdl</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This constructor allows the creation of <classname>SoapServer</classname>
objects in WSDL or non-WSDL mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>wsdl</parameter></term>
<listitem>
<para>
To use the SoapServer in WSDL mode, pass the URI of a WSDL file.
Otherwise, pass &null; and set the <literal>uri</literal> option to the
target namespace for the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Allow setting a default SOAP version (<literal>soap_version</literal>),
internal character encoding (<literal>encoding</literal>),
and actor URI (<literal>actor</literal>).
</para>
<para>
The <literal>classmap</literal> option can be used to map some WSDL
types to PHP classes. This option must be an array with WSDL types
as keys and names of PHP classes as values.
</para>
<para>
The <literal>typemap</literal> option is an array of type mappings.
Type mapping is an array with keys <literal>type_name</literal>,
<literal>type_ns</literal> (namespace URI), <literal>from_xml</literal>
(callback accepting one string parameter) and <literal>to_xml</literal>
(callback accepting one object parameter).
</para>
<para>
The <literal>cache_wsdl</literal> option is one of
<constant>WSDL_CACHE_NONE</constant>,
<constant>WSDL_CACHE_DISK</constant>,
<constant>WSDL_CACHE_MEMORY</constant> or
<constant>WSDL_CACHE_BOTH</constant>.
</para>
<para>
There is also a <literal>features</literal> option which can be set to
<constant>SOAP_WAIT_ONE_WAY_CALLS</constant>,
<constant>SOAP_SINGLE_ELEMENT_ARRAYS</constant>,
<constant>SOAP_USE_XSI_ARRAY_TYPE</constant>.
</para>
<para>
The <literal>send_errors</literal> option can be set to &false; to sent a
generic error message ("Internal error") instead of the specific error
message sent otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapServer::SoapServer</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$server = new SoapServer("some.wsdl");
$server = new SoapServer("some.wsdl", array('soap_version' => SOAP_1_2));
$server = new SoapServer("some.wsdl", array('actor' => "http://example.org/ts-tests/C"));
$server = new SoapServer("some.wsdl", array('encoding'=>'ISO-8859-1'));
$server = new SoapServer(null, array('uri' => "http://test-uri/"));
class MyBook {
public $title;
public $author;
}
$server = new SoapServer("books.wsdl", array('classmap' => array('book' => "MyBook")));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::SoapClient</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

97
reference/soap/soapvar/construct.xml
View File

@@ -18,11 +18,106 @@
<methodparam choice="opt"><type>string</type><parameter>nodeNamespace</parameter><initializer>""</initializer></methodparam>
</constructorsynopsis>
<para>
&info.function.alias; <methodname>SoapVar::SoapVar</methodname>
Constructs a new <classname>SoapVar</classname> object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The data to pass or return.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The encoding ID, one of the <literal>XSD_...</literal> constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type_name</parameter></term>
<listitem>
<para>
The type name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type_namespace</parameter></term>
<listitem>
<para>
The type namespace.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>node_name</parameter></term>
<listitem>
<para>
The XML node name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>node_namespace</parameter></term>
<listitem>
<para>
The XML node namespace.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapVar::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
class SOAPStruct {
function SOAPStruct($s, $i, $f)
{
$this->varString = $s;
$this->varInt = $i;
$this->varFloat = $f;
}
}
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$struct = new SOAPStruct('arg', 34, 325.325);
$soapstruct = new SoapVar($struct, SOAP_ENC_OBJECT, "SOAPStruct", "http://soapinterop.org/xsd");
$client->echoStruct(new SoapParam($soapstruct, "inputStruct"));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__soapCall</methodname></member>
<member><methodname>SoapParam::__construct</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

141
reference/soap/soapvar/soapvar.xml
View File

@@ -1,141 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="soapvar.soapvar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapVar::SoapVar</refname>
<refpurpose>SoapVar constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>SoapVar::SoapVar</methodname>
<methodparam><type>mixed</type><parameter>data</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>type_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>type_namespace</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>node_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>node_namespace</parameter></methodparam>
</methodsynopsis>
<para>
Constructs a new <classname>SoapVar</classname> object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The data to pass or return.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The encoding ID, one of the <literal>XSD_...</literal> constants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type_name</parameter></term>
<listitem>
<para>
The type name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type_namespace</parameter></term>
<listitem>
<para>
The type namespace.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>node_name</parameter></term>
<listitem>
<para>
The XML node name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>node_namespace</parameter></term>
<listitem>
<para>
The XML node namespace.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapVar::SoapVar</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
class SOAPStruct {
function SOAPStruct($s, $i, $f)
{
$this->varString = $s;
$this->varInt = $i;
$this->varFloat = $f;
}
}
$client = new SoapClient(null, array('location' => "http://localhost/soap.php",
'uri' => "http://test-uri/"));
$struct = new SOAPStruct('arg', 34, 325.325);
$soapstruct = new SoapVar($struct, SOAP_ENC_OBJECT, "SOAPStruct", "http://soapinterop.org/xsd");
$client->echoStruct(new SoapParam($soapstruct, "inputStruct"));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__soapCall</methodname></member>
<member><methodname>SoapParam::SoapParam</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->