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

Update ext/soap docs to the new markup

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275958 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Michael Maclean 2009-02-16 21:27:28 +00:00
parent 01253d3618
commit 18a3b717d6
48 changed files with 2719 additions and 2028 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
reference/soap/book.xml
View file

@ -1,12 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: webservice -->
<!-- Membership: bundled, external -->
<!-- $Revision: 1.3 $ -->
<book xml:id="book.soap" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>SOAP</title>
<!-- {{{ preface -->
<titleabbrev>SOAP</titleabbrev>
<preface xml:id="intro.soap">
&reftitle.intro;
<para>
@ -16,12 +14,20 @@
xlink:href="&spec.wsdl;">WSDL 1.1</link> specifications.
</para>
</preface>
<!-- }}} -->
&reference.soap.setup;
&reference.soap.constants;
<!-- &reference.soap.examples; -->
&reference.soap.reference;
&reference.soap.soapclient;
&reference.soap.soapserver;
&reference.soap.soapfault;
&reference.soap.soapheader;
&reference.soap.soapparam;
&reference.soap.soapvar;
</book>
<!-- Keep this comment at the end of the file

32
reference/soap/configure.xml Normal file
View file

@ -0,0 +1,32 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<section xml:id="soap.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<!-- There are various PECL related entities in language-snippets.ent -->
<para>
To enable SOAP support, configure PHP with --enable-soap.
</para>
</section>
<!-- 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:"../../../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
-->

1589
reference/soap/constants.xml
View file

File diff suppressed because it is too large Load diff

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

@ -1,21 +1,21 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.is-soap-fault" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.is-soap-fault" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>is_soap_fault</refname>
<refpurpose>
Checks if SOAP call was failed
</refpurpose>
<refpurpose>Checks if a SOAP call has failed</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>is_soap_fault</methodname>
<methodparam><type>mixed</type><parameter>obj</parameter></methodparam>
<methodparam><type>mixed</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
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
<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
@ -29,27 +29,31 @@
parameter is a <classname>SoapFault</classname> object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>obj</parameter></term>
<term><parameter>object</parameter></term>
<listitem>
<para>
The tested object.
The object to test.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<!-- See also &return.success; -->
<para>
&return.success;
This will return <literal>true</literal> on error, and <literal>false</literal> otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -84,15 +88,17 @@ try {
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><xref linkend="function.soap-soapfault-construct" /></member>
<member><methodname>SoapClient::SoapClient</methodname></member>
<member><methodname>SoapFault::SoapFault</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

50
reference/soap/functions/soap-soapclient-call.xml
View file

@ -1,50 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.soap-soapclient-call" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SoapClient->__call</refname>
<refpurpose>
Calls a SOAP function (deprecated)
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>mixed</type>
<methodname>__call</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>array</type><parameter>arguments</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>input_headers</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>output_headers</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This method is deprecated. Use <xref
linkend="function.soap-soapclient-soapcall" /> instead of it.
</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:"../../../../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
-->

65
reference/soap/functions/soap-soapclient-getlastrequestheaders.xml
View file

@ -1,65 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.soap-soapclient-getlastrequestheaders" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SoapClient->__getLastRequestHeaders</refname>
<refpurpose>
Returns last SOAP request headers
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>__getLastRequestHeaders</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<note>
<para>
This method works only if the <classname>SoapClient</classname> object
was created with the <literal>trace</literal> option.
</para>
</note>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The last SOAP request headers.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><xref linkend="function.soap-soapclient-getlastrequest" /></member>
<member><xref linkend="function.soap-soapclient-getlastresponse" /></member>
<member><xref linkend="function.soap-soapclient-getlastresponseheaders" /></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:"../../../../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
-->

65
reference/soap/functions/soap-soapclient-getlastresponseheaders.xml
View file

@ -1,65 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.soap-soapclient-getlastresponseheaders" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SoapClient->__getLastResponseHeaders</refname>
<refpurpose>
Returns last SOAP response headers.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>__getLastResponseHeaders</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<note>
<para>
This method works only if the <classname>SoapClient</classname> object
was created with the <literal>trace</literal> option.
</para>
</note>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The last SOAP response headers.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><xref linkend="function.soap-soapclient-getlastresponse" /></member>
<member><xref linkend="function.soap-soapclient-getlastrequest" /></member>
<member><xref linkend="function.soap-soapclient-getlastrequestheaders" /></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:"../../../../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
-->

112
reference/soap/functions/soap-soapclient-soapcall.xml
View file

@ -1,112 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.soap-soapclient-soapcall" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SoapClient->__soapCall</refname>
<refpurpose>
Calls a SOAP function
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>__soapCall</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>array</type><parameter>arguments</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>input_headers</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">output_headers</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
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 <classname>SoapClient</classname>
methods. This method useful in non-WSDL mode when <literal>soapaction</literal>
is unknown, <literal>uri</literal> differs from the default or when sending
and/or receiving SOAP Headers.
</para>
<para>
On error, a call to a SOAP function can cause PHP to throw exceptions or return a
<classname>SoapFault</classname> object if exceptions are disabled.
To check if the function call failed to catch the SoapFault exceptions,
check the result with <function>is_soap_fault</function>.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
SOAP functions may return one, or multiple values. If only one value is returned
by the SOAP function, the return value of <literal>__soapCall</literal> will be
a simple value (e.g. an integer, a string, etc). If multiple values are
returned, <literal>__soapCall</literal> will return
an associative array of named output parameters.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>SoapClient->__soapCall() Examples</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient("some.wsdl");
$client->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'));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><xref linkend="function.soap-soapparam-construct" /></member>
<member><xref linkend="function.soap-soapvar-construct" /></member>
<member><xref linkend="function.soap-soapheader-construct" /></member>
<member><xref linkend="function.soap-soapfault-construct" /></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:"../../../../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
-->

52
reference/soap/functions/soap-soapserver-fault.xml
View file

@ -1,52 +0,0 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.soap-soapserver-fault" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SoapServer->fault</refname>
<refpurpose>Issue SoapServer fault indicating an error</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapServer</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>fault</methodname>
<methodparam><type>string</type><parameter>code</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>actor</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>details</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapfault-construct" /></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:"../../../../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
-->

46
reference/soap/functions/use-soap-error-handler.xml
View file

@ -1,18 +1,52 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.use-soap-error-handler" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.use-soap-error-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>use_soap_error_handler</refname>
<refpurpose>Set whether to use the SOAP error handler and return the former value</refpurpose>
<refpurpose>Set whether to use the SOAP error handler</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>use_soap_error_handler</methodname>
<methodparam choice="opt"><type>bool</type><parameter>handler</parameter><initializer>true</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>handler</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
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 <literal>true</literal>, details of errors
in a SoapServer application will be sent to the clients. If <literal>false</literal>,
no information will be sent.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>handler</parameter></term>
<listitem>
<para>
Set to <literal>true</literal> to send error details to clients.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>set_error_handler</function></member>
<member><function>set_exception_handler</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

211
reference/soap/ini.xml
View file

@ -1,148 +1,127 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.12 $ -->
<section xml:id="soap.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>SOAP Configuration Options</title>
<title>SOAP &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
<entry>Changelog</entry>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
<entry>&Changelog;</entry>
</row>
</thead>
<tbody>
<row>
<entry><link linkend="ini.soap.wsdl-cache-enabled">soap.wsdl_cache_enabled</link></entry>
<entry>"1"</entry>
<entry>soap.wsdl_cache_enabled</entry>
<entry>1</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since PHP 5.0.0.</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.soap.wsdl-cache-dir">soap.wsdl_cache_dir</link></entry>
<entry>"/tmp"</entry>
<entry>soap.wsdl_cache_dir</entry>
<entry>/tmp</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since PHP 5.0.0.</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.soap.wsdl-cache-ttl">soap.wsdl_cache_ttl</link></entry>
<entry>"86400"</entry>
<entry>soap.wsdl_cache_ttl</entry>
<entry>86400</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since PHP 5.0.0.</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.soap.wsdl-cache-limit">soap.wsdl_cache_limit</link></entry>
<entry>"5"</entry>
<entry>soap.wsdl_cache</entry>
<entry>1</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since PHP 5.1.5.</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry><link linkend="ini.soap.wsdl-cache">soap.wsdl_cache</link></entry>
<entry>"1"</entry>
<entry>soap.wsdl_cache_limit</entry>
<entry>5</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since PHP 5.1.5.</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
</tbody>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
</para>
&ini.descriptions.title;
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.soap.wsdl-cache-enabled">
<term>
<parameter>soap.wsdl_cache_enabled</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Enables or disables the WSDL caching feature.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.soap.wsdl-cache-dir">
<term>
<parameter>soap.wsdl_cache_dir</parameter>
<type>string</type>
</term>
<listitem>
<para>
Sets the directory name where the SOAP extension will put cache files.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.soap.wsdl-cache-ttl">
<term>
<parameter>soap.wsdl_cache_ttl</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Sets the number of seconds (time to live) that cached files will be used
instead of the originals.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.soap.wsdl-cache-limit">
<term>
<parameter>soap.wsdl_cache_limit</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Maximum number of in-memory cached WSDL files. Adding further files into
a full memory cache will delete the oldest files from it.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.soap.wsdl-cache">
<term>
<parameter>soap.wsdl_cache</parameter>
<type>integer</type>
</term>
<listitem>
<para>
If <parameter>soap.wsdl_cache_enabled</parameter> is on, this setting
determines the type of caching. It can be any of:
<constant>WSDL_CACHE_NONE</constant> (<literal>0</literal>),
<constant>WSDL_CACHE_DISK</constant> (<literal>1</literal>),
<constant>WSDL_CACHE_MEMORY</constant> (<literal>2</literal>) or
<constant>WSDL_CACHE_BOTH</constant> (<literal>3</literal>). This can
also be set via the <parameter>options</parameter> array in the
<classname>SoapClient</classname> or <classname>SoapServer</classname>
constructor.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<variablelist>
<varlistentry xml:id="ini.soap.wsdl-cache-enabled">
<term>
<parameter>soap.wsdl_cache_enabled</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Enables or disables the WSDL caching feature.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.soap.wsdl-cache-dir">
<term>
<parameter>soap.wsdl_cache_dir</parameter>
<type>string</type>
</term>
<listitem>
<para>
Sets the directory name where the SOAP extension will put cache files.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.soap.wsdl-cache-ttl">
<term>
<parameter>soap.wsdl_cache_ttl</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Sets the number of seconds (time to live) that cached files will be used
instead of the originals.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.soap.wsdl-cache">
<term>
<parameter>soap.wsdl_cache</parameter>
<type>integer</type>
</term>
<listitem>
<para>
If <parameter>soap.wsdl_cache_enabled</parameter> is on, this setting
determines the type of caching. It can be any of:
<constant>WSDL_CACHE_NONE</constant> (<literal>0</literal>),
<constant>WSDL_CACHE_DISK</constant> (<literal>1</literal>),
<constant>WSDL_CACHE_MEMORY</constant> (<literal>2</literal>) or
<constant>WSDL_CACHE_BOTH</constant> (<literal>3</literal>). This can
also be set via the <parameter>options</parameter> array in the
<classname>SoapClient</classname> or <classname>SoapServer</classname>
constructor.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.soap.wsdl-cache-limit">
<term>
<parameter>soap.wsdl_cache_limit</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Maximum number of in-memory cached WSDL files. Adding further files into
a full memory cache will delete the oldest files from it.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- 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:"../../../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
-->

174
reference/soap/reference.xml
View file

@ -1,174 +1,13 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.14 $ -->
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.15 $ -->
<reference xml:id="ref.soap" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>SOAP &Functions;</title>
<partintro>
<!-- FIXME: Upgrade to the new-oo-markup -->
<section xml:id='soap.classes'>
&reftitle.classes;
<section xml:id='soap.class.soapclient'>
<title><classname>SoapClient</classname></title>
<para></para>
<section xml:id='soap.class.soapclient.constructor'>
&reftitle.constructor;
<itemizedlist>
<listitem>
<para><xref linkend='function.soap-soapclient-construct' /> -
constructs a new SoapClient object</para>
</listitem>
</itemizedlist>
</section>
<section xml:id='soap.class.soapclient.methods'>
&reftitle.methods;
<itemizedlist>
<listitem>
<para><xref linkend='function.soap-soapclient-call' /> - Calls a SOAP function (deprecated)</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-dorequest' /> - Performs a SOAP request</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-getfunctions' /> - Returns list of SOAP functions</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-getlastrequest' /> - Returns last SOAP request</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-getlastrequestheaders' /> - Returns last SOAP request headers</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-getlastresponse' /> - Returns last SOAP response</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-getlastresponseheaders' /> - Returns last SOAP response headers</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-gettypes' /> - Returns list of SOAP types</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-setcookie' /> - Sets the
cookie that will be sent with the SOAP request</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapclient-soapcall' /> - Calls a SOAP function</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id='soap.class.soapfault'>
<title><classname>SoapFault</classname></title>
<para></para>
<section xml:id='soap.class.soapfault.constructor'>
&reftitle.constructor;
<itemizedlist>
<listitem>
<para><xref linkend='function.soap-soapfault-construct' /> - construct a new SoapFault object</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id='soap.class.soapheader'>
<title><classname>SoapHeader</classname></title>
<para>
<classname>SoapHeader</classname> 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 <xref
linkend='function.soap-soapclient-soapcall' /> method to pass a SOAP header or
in a SOAP header handler to return the header in a SOAP response.
</para>
<section xml:id='soap.class.soapheader.constructor'>
&reftitle.constructor;
<itemizedlist>
<listitem>
<para><xref linkend='function.soap-soapheader-construct' /> - construct a new SoapHeader object</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id='soap.class.soapparam'>
<title><classname>SoapParam</classname></title>
<para>
<classname>SoapParam</classname> is a special low-level class for naming
parameters and returning values in <literal>non-WSDL</literal> mode.
It's just a data holder and it does not have any special methods except
its constructor.
</para>
<section xml:id='soap.class.soapparam.constructor'>
&reftitle.constructor;
<itemizedlist>
<listitem>
<para><xref linkend='function.soap-soapparam-construct' /> - construct a new SoapParam object</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id='soap.class.soapserver'>
<title><classname>SoapServer</classname></title>
<para></para>
<section xml:id='soap.class.soapserver.constructor'>
&reftitle.constructor;
<itemizedlist>
<listitem>
<para><xref linkend='function.soap-soapserver-construct' /> - construct a new SoapServer object</para>
</listitem>
</itemizedlist>
</section>
<section xml:id='soap.class.soapserver.methods'>
&reftitle.methods;
<itemizedlist>
<listitem>
<para><xref linkend='function.soap-soapserver-addfunction' /> - Adds one or several functions those will handle SOAP requests</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapserver-fault' /> - </para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapserver-getfunctions' /> - Returns list of defined functions</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapserver-handle' /> - Handles a SOAP request</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapserver-setclass' /> - Sets class which will handle SOAP requests</para>
</listitem>
<listitem>
<para><xref linkend='function.soap-soapserver-setpersistence' /> - Sets persistence mode of SoapServer</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id='soap.class.soapvar'>
<title><classname>SoapVar</classname></title>
<para>
<classname>SoapVar</classname> is a special low-level class for encoding
parameters and returning values in <literal>non-WSDL</literal> 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.
</para>
<section xml:id='soap.class.soapvar.constructor'>
&reftitle.constructor;
<itemizedlist>
<listitem>
<para><xref linkend='function.soap-soapvar-construct' /> - construct a new SoapVar object</para>
</listitem>
</itemizedlist>
</section>
</section>
</section>
</partintro>
&reference.soap.entities.functions;
</reference>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -189,3 +28,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

12
reference/soap/setup.xml
View file

@ -1,40 +1,38 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<chapter xml:id="soap.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="soap.requirements">
&reftitle.required;
<!-- Use &no.requirement; if there no requirement -->
<para>
This extension makes use of the <link xlink:href="&url.libxml;">GNOME xml
library</link>. Download and install this library. You will need at
least libxml-2.5.4.
</para>
</section>
<!-- }}} -->
<!-- {{{ Installation -->
<section xml:id="soap.installation">
<section xml:id="extname.installation">
&reftitle.install;
<para>
This extension is only available if PHP was configured with
<option role="configure">--enable-soap</option>.
</para>
</section>
<!-- or &reference.soap.configure; -->
<!-- }}} -->
<!-- {{{ Configuration -->
&reference.soap.ini;
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="soap.resources">
&reftitle.resources;
&no.resource;
&no.resource;
</section>
<!-- }}} -->
</chapter>

69
reference/soap/soapclient.xml Normal file
View file

@ -0,0 +1,69 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xml:id="class.soapclient" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The <classname>SoapClient</classname> class</title>
<titleabbrev>SoapClient</titleabbrev>
<partintro>
<!-- {{{ SoapClient intro -->
<section xml:id="soapclient.intro">
&reftitle.intro;
<para>
The SoapClient class provides a client for <link xlink:href="&spec.soap1.1;">SOAP 1.1</link>, <link
xlink:href="&spec.soap1.2;">SOAP 1.2</link> servers. It can be used in WSDL
or non-WSDL mode.
</para>
</section>
<!-- }}} -->
<section xml:id="soapclient.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SoapClient</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.soapclient')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.soap.entities.soapclient;
</phpdoc:classref>
<!-- 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:"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
-->

44
reference/soap/soapclient/call.xml Normal file
View file

@ -0,0 +1,44 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.call" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient::__call</refname>
<refpurpose>Calls a SOAP function (deprecated)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapClient::__call</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>string</type><parameter>arguments</parameter></methodparam>
</methodsynopsis>
<para>
This method is deprecated. Use <xref
linkend="soapclient.soapcall" /> instead of it.
</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:"../../../../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
-->

43
reference/soap/soapclient/construct.xml Normal file
View file

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient::__construct</refname>
<refpurpose>SoapClient constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>SoapClient::SoapClient</methodname>
<methodparam><type>mixed</type><parameter>wsdl</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
&info.function.alias; <methodname>SoapClient::SoapClient</methodname>
</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:"../../../../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
-->

62
reference/soap/functions/soap-soapclient-dorequest.xml → reference/soap/soapclient/dorequest.xml
View file

@ -1,27 +1,22 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.soap-soapclient-dorequest" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.dorequest" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__doRequest</refname>
<refpurpose>
Performs a SOAP request
</refpurpose>
<refname>SoapClient::__doRequest</refname>
<refpurpose>Performs a SOAP request</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>__doRequest</methodname>
<methodparam><type>string</type><parameter>request</parameter></methodparam>
<methodparam><type>string</type><parameter>location</parameter></methodparam>
<methodparam><type>string</type><parameter>action</parameter></methodparam>
<methodparam><type>int</type><parameter>version</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>one_way</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SoapClient::__doRequest</methodname>
<methodparam><type>string</type><parameter>request</parameter></methodparam>
<methodparam><type>string</type><parameter>location</parameter></methodparam>
<methodparam><type>string</type><parameter>action</parameter></methodparam>
<methodparam><type>int</type><parameter>version</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>one_way</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Performs SOAP request over HTTP.
</para>
@ -71,6 +66,8 @@
<term><parameter>one_way</parameter></term>
<listitem>
<para>
If <literal>one_way</literal> is set to 1, this method returns nothing.
Use this where a response is not expected.
</para>
</listitem>
</varlistentry>
@ -85,35 +82,11 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.1.3</entry>
<entry>
The <parameter>one_way</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<title><function>SoapClient::__doRequest</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -148,7 +121,6 @@ var_dump($x->Add(3,4));
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

49
reference/soap/functions/soap-soapclient-getfunctions.xml → reference/soap/soapclient/getfunctions.xml
View file

@ -1,42 +1,43 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.soap-soapclient-getfunctions" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.getfunctions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__getFunctions</refname>
<refpurpose>
Returns list of SOAP functions
</refpurpose>
<refname>SoapClient::__getFunctions</refname>
<refpurpose>Returns list of available SOAP functions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>array</type>
<methodname>__getFunctions</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapClient::__getFunctions</methodname>
<void />
</methodsynopsis>
<para>
Returns the list of SOAP functions.
Returns a list of available SOAP functions.
</para>
<para>
This function only works in WSDL mode.
</para>
<note>
<para>
This function works only in WSDL mode.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The list of SOAP functions.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>SoapClient->__getFunctions() example</title>
<title><function>SoapClient::__getFunctions</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -48,14 +49,16 @@ var_dump($client->__getFunctions());
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><methodname>SoapClient::SoapClient</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

49
reference/soap/functions/soap-soapclient-getlastrequest.xml → reference/soap/soapclient/getlastrequest.xml
View file

@ -1,35 +1,41 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.soap-soapclient-getlastrequest" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.getlastrequest" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__getLastRequest</refname>
<refpurpose>
Returns last SOAP request
</refpurpose>
<refname>SoapClient::__getLastRequest</refname>
<refpurpose>Returns last SOAP request</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>__getLastRequest</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SoapClient::__getLastRequest</methodname>
<void />
</methodsynopsis>
<para>
Returns the XML sent in the last SOAP request.
</para>
<note>
<para>
This method works only if the <classname>SoapClient</classname> object
was created with the <literal>trace</literal> option.
was created with the <literal>trace</literal> option set to <literal>true</literal>.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The last SOAP request.
The last SOAP request, as an XML string.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -47,17 +53,18 @@ echo "REQUEST:\n" . $client->__getLastRequest() . "\n";
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><xref linkend="function.soap-soapclient-getlastrequestheaders" /></member>
<member><xref linkend="function.soap-soapclient-getlastresponse" /></member>
<member><xref linkend="function.soap-soapclient-getlastresponseheaders" /></member>
<member><methodname>SoapClient::__getLastRequestHeaders</methodname></member>
<member><methodname>SoapClient::__getLastResponse</methodname></member>
<member><methodname>SoapClient::__getLastResponseHeaders</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

90
reference/soap/soapclient/getlastrequestheaders.xml Normal file
View file

@ -0,0 +1,90 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.getlastrequestheaders" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient::__getLastRequestHeaders</refname>
<refpurpose>Returns the SOAP headers from the last request</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SoapClient::__getLastRequestHeaders</methodname>
<void />
</methodsynopsis>
<para>
Returns the SOAP headers from the last request.
</para>
<note>
<para>
This function only works if the
<classname>SoapClient</classname> object was created with the <literal>trace</literal>
option set to <literal>true</literal>.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The last SOAP request headers.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>SoapClient->__getLastRequest() example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = SoapClient("some.wsdl", array('trace' => 1));
$result = $client->SomeFunction();
echo "REQUEST HEADERS:\n" . $client->__getLastRequestHeaders() . "\n";
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__getLastResponseHeaders</methodname></member>
<member><methodname>SoapClient::__getLastRequest</methodname></member>
<member><methodname>SoapClient::__getLastResponse</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:"../../../../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
-->

51
reference/soap/functions/soap-soapclient-getlastresponse.xml → reference/soap/soapclient/getlastresponse.xml
View file

@ -1,35 +1,41 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.soap-soapclient-getlastresponse" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.getlastresponse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__getLastResponse</refname>
<refpurpose>
Returns last SOAP response.
</refpurpose>
<refname>SoapClient::__getLastResponse</refname>
<refpurpose>Returns last SOAP response</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>__getLastResponse</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SoapClient::__getLastResponse</methodname>
<void />
</methodsynopsis>
<para>
Returns the XML sent in the last SOAP response.
</para>
<note>
<para>
This method works only if the <classname>SoapClient</classname> object
was created with the <literal>trace</literal> option.
was created with the <literal>trace</literal> option set to <literal>true</literal>.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The last SOAP response.
The last SOAP response, as an XML string.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -40,24 +46,25 @@
<?php
$client = SoapClient("some.wsdl", array('trace' => 1));
$result = $client->SomeFunction();
echo "RESPONSE:\n" . $client->__getLastResponse() . "\n";
echo "REsponse:\n" . $client->__getLastResponse() . "\n";
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><xref linkend="function.soap-soapclient-getlastresponseheaders" /></member>
<member><xref linkend="function.soap-soapclient-getlastrequest" /></member>
<member><xref linkend="function.soap-soapclient-getlastrequestheaders" /></member>
<member><methodname>SoapClient::__getLastResponseHeaders</methodname></member>
<member><methodname>SoapClient::__getLastRequest</methodname></member>
<member><methodname>SoapClient::__getLastRequestHeaders</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

90
reference/soap/soapclient/getlastresponseheaders.xml Normal file
View file

@ -0,0 +1,90 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.getlastresponseheaders" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient::__getLastResponseHeaders</refname>
<refpurpose>Returns the SOAP headers from the last response</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SoapClient::__getLastResponseHeaders</methodname>
<void />
</methodsynopsis>
<para>
Returns the SOAP headers from the last response.
</para>
<note>
<para>
This function only works if the
<classname>SoapClient</classname> object was created with the <literal>trace</literal>
option set to <literal>true</literal>.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The last SOAP response headers.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>SoapClient->__getLastResponse() example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = SoapClient("some.wsdl", array('trace' => 1));
$result = $client->SomeFunction();
echo "RESPONSE HEADERS:\n" . $client->__getLastResponseHeaders() . "\n";
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapClient::__getLastRequestHeaders</methodname></member>
<member><methodname>SoapClient::__getLastRequest</methodname></member>
<member><methodname>SoapClient::__getLastResponse</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:"../../../../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
-->

48
reference/soap/functions/soap-soapclient-gettypes.xml → reference/soap/soapclient/gettypes.xml
View file

@ -1,37 +1,45 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.soap-soapclient-gettypes" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.gettypes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__getTypes</refname>
<refpurpose>
Returns list of SOAP types
</refpurpose>
<refname>SoapClient::__getTypes</refname>
<refpurpose>Returns a list of SOAP types</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>array</type>
<methodname>__getTypes</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>SoapClient::__getTypes</methodname>
<void />
</methodsynopsis>
<para>
This function works only in WSDL mode.
Returns an array of types described in the WSDL for the Web service.
</para>
<note>
<para>
This function only works in WSDL mode.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The list of SOAP types.
An <literal>array</literal> of SOAP types.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>SoapClient->__getTypes() example</title>
<title><function>SoapClient::__getTypes</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -43,14 +51,16 @@ var_dump($client->__getTypes());
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><methodname>SoapClient::SoapClient</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/soap/functions/soap-soapclient-setcookie.xml → reference/soap/soapclient/setcookie.xml
View file

@ -1,23 +1,19 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.soap-soapclient-setcookie" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.setcookie" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__setCookie</refname>
<refpurpose>
Sets the cookie that will be sent with the SOAP request
</refpurpose>
<refname>SoapClient::__setCookie</refname>
<refpurpose>The __setCookie purpose</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>void</type>
<methodname>__setCookie</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapClient::__setCookie</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Defines a cookie to be sent along with the SOAP requests.
</para>
@ -28,6 +24,7 @@
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -51,12 +48,14 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

67
reference/soap/functions/soap-soapclient-setlocation.xml → reference/soap/soapclient/setlocation.xml
View file

@ -1,24 +1,21 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.soap-soapclient-setlocation" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="soapclient.setlocation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__setLocation</refname>
<refpurpose>
Sets the location option.
</refpurpose>
<refname>SoapClient::__setLocation</refname>
<refpurpose>Sets the location of the Web service to use.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>string</type>
<methodname>__setLocation</methodname>
<methodparam choice="opt"><type>string</type><parameter>location</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SoapClient::__setLocation</methodname>
<methodparam choice="opt"><type>string</type><parameter>new_location</parameter></methodparam>
</methodsynopsis>
<para>
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 <literal>location</literal> option when constructing the SoapClient.
</para>
<note>
<para>
@ -27,34 +24,36 @@
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>location</parameter></term>
<term><parameter>new_location</parameter></term>
<listitem>
<para>
The URL to be set. If not specified, the existing value of the location
option will be unset.
The new endpoint URL.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The old value of the location option.
The old endpoint URL.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Set A Location</title>
<programlisting role="php">
<para>
<example>
<title><function>SoapClient::__setLocation</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient('http://example.com/webservice.php?wsdl');
@ -67,16 +66,26 @@ echo $old_location;
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
http://www.somethirdparty.com
]]>
</screen>
</example>
</para>
</screen>
</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

49
reference/soap/functions/soap-soapclient-setsoapheaders.xml → reference/soap/soapclient/setsoapheaders.xml
View file

@ -1,22 +1,18 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.soap-soapclient-setsoapheaders" xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="soapclient.setsoapheaders" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__setSoapHeaders</refname>
<refpurpose>
Sets SOAP headers for subsequent calls.
</refpurpose>
<refname>SoapClient::__setSoapHeaders</refname>
<refpurpose>Sets SOAP headers for subsequent calls.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<methodsynopsis>
<type>bool</type>
<methodname>__setSoapHeaders</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>headers</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SoapClient::__setSoapHeaders</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>soapheaders</parameter></methodparam>
</methodsynopsis>
<para>
Defines headers to be sent along with the SOAP requests.
</para>
@ -26,12 +22,13 @@
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>headers</parameter></term>
<term><parameter>soapheaders</parameter></term>
<listitem>
<para>
The headers to be set. If not specified, the headers will be deleted.
@ -41,18 +38,20 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Set A Single Header</title>
<programlisting role="php">
<para>
<example>
<title><function>SoapClient::__setSoapHeaders</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -67,9 +66,15 @@ $client->__setSoapHeaders($header);
$client->__soapCall("echoVoid", null);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Set Multiple Headers</title>

175
reference/soap/soapclient/soapcall.xml Normal file
View file

@ -0,0 +1,175 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.soapcall" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient::__soapCall</refname>
<refpurpose>Calls a SOAP function</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>SoapClient::__soapCall</methodname>
<methodparam><type>string</type><parameter>function_name</parameter></methodparam>
<methodparam><type>array</type><parameter>arguments</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>input_headers</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">output_headers</parameter></methodparam>
</methodsynopsis>
<para>
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 <classname>SoapClient</classname>
methods. This method useful in non-WSDL mode when <literal>soapaction</literal>
is unknown, <literal>uri</literal> differs from the default or when sending
and/or receiving SOAP Headers.
</para>
<para>
On error, a call to a SOAP function can cause PHP to throw exceptions or return a
<classname>SoapFault</classname> object if exceptions are disabled.
To check if the function call failed to catch the SoapFault exceptions,
check the result with <function>is_soap_fault</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>function_name</parameter></term>
<listitem>
<para>
The name of the SOAP function to call.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arguments</parameter></term>
<listitem>
<para>
An array of the arguments to pass to the function. This can be either
an ordered or an associative array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An associative array of options to pass to the client.
</para>
<para>
The <literal>location</literal> option is the URL of the remote Web service.
</para>
<para>
The <literal>uri</literal> option is the target namespace of the SOAP service.
</para>
<para>
The <literal>soapaction</literal> option is the action to call.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>input_headers</parameter></term>
<listitem>
<para>
An array of headers to be sent along with the SOAP request.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>output_headers</parameter></term>
<listitem>
<para>
If supplied, this array will be filled with the headers from the SOAP response.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
SOAP functions may return one, or multiple values. If only one value is returned
by the SOAP function, the return value of <literal>__soapCall</literal> will be
a simple value (e.g. an integer, a string, etc). If multiple values are
returned, <literal>__soapCall</literal> will return
an associative array of named output parameters.
</para>
<para>
On error, if the SoapClient object was constructed with the <literal>trace</literal>
option set to <literal>false</literal>, a SoapFault object will be returned.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SoapClient::__soapCall</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient("some.wsdl");
$client->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'));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&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><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:"../../../../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/functions/soap-soapclient-construct.xml → reference/soap/soapclient/soapclient.xml
View file

@ -1,27 +1,25 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.13 $ -->
<refentry xml:id="function.soap-soapclient-construct" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapclient.soapclient" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapClient->__construct</refname>
<refpurpose>
SoapClient constructor
</refpurpose>
<refname>SoapClient::SoapClient</refname>
<refpurpose>SoapClient constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapClient</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam><type>mixed</type><parameter>wsdl</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<methodsynopsis>
<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>
@ -86,18 +84,19 @@
</para>
<para>
Setting the boolean <literal>trace</literal> option enables use of the
methods <link linkend="function.soap-soapclient-getlastrequest">
methods <link linkend="soapclient.getlastrequest">
SoapClient->__getLastRequest</link>,
<link linkend="function.soap-soapclient-getlastrequestheaders">
<link linkend="soapclient.getlastrequestheaders">
SoapClient->__getLastRequestHeaders</link>,
<link linkend="function.soap-soapclient-getlastresponse">
<link linkend="soapclient.getlastresponse">
SoapClient->__getLastResponse</link> and
<link linkend="function.soap-soapclient-getlastresponseheaders">
<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="function.soap-soapfault-construct">
soap errors throw exceptions of type <link
linkend="soapfault.soapfault">
SoapFault</link>.
</para>
<para>
@ -140,12 +139,13 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>SoapClient examples</title>
<programlisting role="php">
<para>
<example>
<title><function>SoapClient::SoapClient</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -188,11 +188,12 @@ $server = new SoapClient("books.wsdl", array('classmap' => array('book' => "MyBo
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

112
reference/soap/soapfault.xml Normal file
View file

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xml:id="class.soapfault" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SoapFault class</title>
<titleabbrev>SoapFault</titleabbrev>
<partintro>
<!-- {{{ SoapFault intro -->
<section xml:id="soapfault.intro">
&reftitle.intro;
<para>
Represents a SOAP fault.
</para>
</section>
<!-- }}} -->
<section xml:id="soapfault.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SoapFault</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SoapFault</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>Exception</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Properties</classsynopsisinfo>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.soapfault')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ SoapFault properties -->
<section xml:id="soapfault.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="soapfault.props.message">
<term><varname>message</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapfault.props.code">
<term><varname>code</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapfault.props.file">
<term><varname>file</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
<varlistentry xml:id="soapfault.props.line">
<term><varname>line</varname></term>
<listitem>
<para>Prop description</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.soap.entities.soapfault;
</phpdoc:classref>
<!-- 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:"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
-->

50
reference/soap/functions/soap-soapfault-construct.xml → reference/soap/soapfault/soapfault.xml
View file

@ -1,33 +1,31 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.soap-soapfault-construct" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapfault.soapfault" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapFault->__construct</refname>
<refpurpose>
SoapFault constructor
</refpurpose>
<refname>SoapFault::SoapFault</refname>
<refpurpose>SoapFault constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapFault</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</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>mixed</type><parameter>detail</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>faultname</parameter></methodparam>
<methodparam choice="opt"><type>SoapHeader</type><parameter>headerfault</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<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 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;
standard elements of a SOAP Fault.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -60,6 +58,7 @@
<term><parameter>detail</parameter></term>
<listitem>
<para>
More details about the cause of the error.
</para>
</listitem>
</varlistentry>
@ -67,7 +66,7 @@
<term><parameter>faultname</parameter></term>
<listitem>
<para>
Can be used to select the proper fault encoding from WSDL.
Can be used to select the proper fault encoding from WSDL.
</para>
</listitem>
</varlistentry>
@ -83,6 +82,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -127,19 +127,17 @@ $server->handle();
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-construct" /></member>
<member><xref linkend="function.soap-soapclient-soapcall" /></member>
<member><xref linkend="function.soap-soapvar-construct" /></member>
<member><xref linkend="function.soap-soapparam-construct" /></member>
<member><xref linkend="function.soap-soapfault-construct" /></member>
<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

54
reference/soap/soapfault/tostring.xml Normal file
View file

@ -0,0 +1,54 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapfault.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapFault::__toString</refname>
<refpurpose>Obtain a string representation of a SoapFault</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapFault::__toString</methodname>
<void />
</methodsynopsis>
<para>
Returns a string representation of the SoapFault.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string describing the SoapFault.
</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:"../../../../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
-->

67
reference/soap/soapheader.xml Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xml:id="class.soapheader" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SoapHeader class</title>
<titleabbrev>SoapHeader</titleabbrev>
<partintro>
<!-- {{{ SoapHeader intro -->
<section xml:id="soapheader.intro">
&reftitle.intro;
<para>
Represents a SOAP header.
</para>
</section>
<!-- }}} -->
<section xml:id="soapheader.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SoapHeader</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SoapHeader</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.soapheader')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.soap.entities.soapheader;
</phpdoc:classref>
<!-- 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:"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
-->

80
reference/soap/functions/soap-soapheader-construct.xml → reference/soap/soapheader/soapheader.xml
View file

@ -1,29 +1,27 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.soap-soapheader-construct" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapheader.soapheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapHeader->__construct</refname>
<refpurpose>
SoapHeader constructor
</refpurpose>
<refname>SoapHeader::SoapHeader</refname>
<refpurpose>SoapHeader constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapHeader</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</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></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>actor</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<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></methodparam>
<methodparam choice="opt"><type>string</type><parameter>actor</parameter></methodparam>
</methodsynopsis>
<para>
Constructs a new <classname>SoapHeader</classname> object.
Constructs a new SoapHeader object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -40,7 +38,7 @@
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the SOAP header element.
The name of the SoapHeader object.
</para>
</listitem>
</varlistentry>
@ -74,11 +72,12 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Basic Example</title>
<title><function>SoapHeader::SoapHeader</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -89,52 +88,23 @@ $client->__soapCall("echoVoid", null, null,
'echoMeStringRequest',
'hello world'));
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Complex Type With Attributes</title>
<programlisting role="php">
<![CDATA[
<?php
$client = new SoapClient('http://example.com/webservice.asmx?wsdl');
$attributes = array('attr1' => '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);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-soapcall" /></member>
<member><xref linkend="function.soap-soapvar-construct" /></member>
<member><xref linkend="function.soap-soapparam-construct" /></member>
<member><methodname>SoapClient::__soapCall</methodname></member>
<member><methodname>SoapVar::SoapVar</methodname></member>
<member><methodname>SoapParam::SoapParam</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

67
reference/soap/soapparam.xml Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xml:id="class.soapparam" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SoapParam class</title>
<titleabbrev>SoapParam</titleabbrev>
<partintro>
<!-- {{{ SoapParam intro -->
<section xml:id="soapparam.intro">
&reftitle.intro;
<para>
Represents parameter to a SOAP call.
</para>
</section>
<!-- }}} -->
<section xml:id="soapparam.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SoapParam</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SoapParam</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.soapparam')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.soap.entities.soapparam;
</phpdoc:classref>
<!-- 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:"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
-->

43
reference/soap/functions/soap-soapparam-construct.xml → reference/soap/soapparam/soapparam.xml
View file

@ -1,26 +1,24 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.soap-soapparam-construct" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapparam.soapparam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapParam->__construct</refname>
<refpurpose>
SoapParam constructor
</refpurpose>
<refname>SoapParam::SoapParam</refname>
<refpurpose>SoapParam constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapParam</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam><type>mixed</type><parameter>data</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<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>
@ -46,11 +44,12 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<title><function>SoapParam::SoapParam</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -62,18 +61,26 @@ $client->SomeFunction(new SoapParam($a, "a"),
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-soapcall" /></member>
<member><xref linkend="function.soap-soapvar-construct" /></member>
<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

68
reference/soap/soapserver.xml Normal file
View file

@ -0,0 +1,68 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xml:id="class.soapserver" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SoapServer class</title>
<titleabbrev>SoapServer</titleabbrev>
<partintro>
<!-- {{{ SoapServer intro -->
<section xml:id="soapserver.intro">
&reftitle.intro;
<para>
The SoapServer class provides a server for the <link xlink:href="&spec.soap1.1;">SOAP 1.1</link> and <link
xlink:href="&spec.soap1.2;">SOAP 1.2</link> protocols. It can be used with or without a WSDL service description.
</para>
</section>
<!-- }}} -->
<section xml:id="soapserver.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SoapServer</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SoapServer</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.soapserver')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.soap.entities.soapserver;
</phpdoc:classref>
<!-- 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:"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
-->

38
reference/soap/functions/soap-soapserver-addfunction.xml → reference/soap/soapserver/addfunction.xml
View file

@ -1,25 +1,23 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.soap-soapserver-addfunction" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.addfunction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer->addFunction</refname>
<refpurpose>
Adds one or several functions those will handle SOAP requests
</refpurpose>
<refname>SoapServer::addFunction</refname>
<refpurpose>Adds one or more functions to handle SOAP requests</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapServer</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>addFunction</methodname>
<methodparam><type>mixed</type><parameter>functions</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapServer::addFunction</methodname>
<methodparam><type>string</type><parameter>functions</parameter></methodparam>
</methodsynopsis>
<para>
Exports one or more functions for remote clients.
Exports one or more functions for remote clients
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -50,17 +48,19 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<title><function>SoapServer::addFunction</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -87,15 +87,17 @@ $server->addFunction(SOAP_FUNCTIONS_ALL);
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapserver-construct" /></member>
<member><xref linkend="function.soap-soapserver-setclass" /></member>
<member><methodname>SoapServer::SoapServer</methodname></member>
<member><methodname>SoapServer::setClass</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

58
reference/soap/soapserver/addsoapheader.xml Normal file
View file

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.addsoapheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer::addSoapHeader</refname>
<refpurpose>Add a SOAP header to the response</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapServer::addSoapHeader</methodname>
<methodparam><type>string</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
Adds a SOAP header to be returned with the response to the current request.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
The header to be returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</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:"../../../../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
-->

115
reference/soap/soapserver/fault.xml Normal file
View file

@ -0,0 +1,115 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.fault" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer::fault</refname>
<refpurpose>Issue SoapServer fault indicating an error</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapServer::fault</methodname>
<methodparam><type>string</type><parameter>code</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>actor</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>details</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Sends a response to the client of the current request indicating an error.
</para>
<note>
<para>
This can only be called when handling a request.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>code</parameter></term>
<listitem>
<para>
The error code to return
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
A brief description of the error
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>actor</parameter></term>
<listitem>
<para>
A string identifying the actor that caused the fault.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>details</parameter></term>
<listitem>
<para>
More details of the fault
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the fault. This can be used to select a name from a WSDL file.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapFault::SoapFault</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:"../../../../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
-->

50
reference/soap/functions/soap-soapserver-getfunctions.xml → reference/soap/soapserver/getfunctions.xml
View file

@ -1,39 +1,43 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.soap-soapserver-getfunctions" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.getfunctions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer->getFunctions</refname>
<refpurpose>
Returns list of defined functions
</refpurpose>
<refname>SoapServer::getFunctions</refname>
<refpurpose>Returns list of defined functions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapServer</classname></ooclass>
<methodsynopsis>
<type>array</type>
<methodname>getFunctions</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>SoapServer::getFunctions</methodname>
<void />
</methodsynopsis>
<para>
Returns a list of the defined functions in the SoapServer object.
This method returns the list of all functions added by
<xref linkend="function.soap-soapserver-addfunction" /> or
<xref linkend="function.soap-soapserver-setclass" />.
<methodname>SoapServer::addFunction</methodname> or
<methodname>SoapServer::setClass</methodname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The list of all functions.
An <literal>array</literal> of the defined functions.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<title><function>SoapServer::getFunctions</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -54,16 +58,18 @@ if ($_SERVER["REQUEST_METHOD"] == "POST") {
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapserver-construct" /></member>
<member><xref linkend="function.soap-soapserver-addfunction" /></member>
<member><xref linkend="function.soap-soapserver-setclass" /></member>
<member><methodname>SoapServer::SoapServer</methodname></member>
<member><methodname>SoapServer::addFunction</methodname></member>
<member><methodname>SoapServer::setClass</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

38
reference/soap/functions/soap-soapserver-handle.xml → reference/soap/soapserver/handle.xml
View file

@ -1,26 +1,24 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.soap-soapserver-handle" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.handle" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer->handle</refname>
<refpurpose>
Handles a SOAP request
</refpurpose>
<refname>SoapServer::handle</refname>
<refpurpose>Handles a SOAP request</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapServer</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>handle</methodname>
<methodparam choice="opt"><type>string</type><parameter>soap_request</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapServer::handle</methodname>
<methodparam choice="opt"><type>string</type><parameter>soap_request</parameter></methodparam>
</methodsynopsis>
<para>
Processes a SOAP request, calls necessary functions, and sends a response
back.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -29,25 +27,27 @@
<term><parameter>soap_request</parameter></term>
<listitem>
<para>
The SOAP request. If this argument is omitted, the request is supposed
to be in the <varname>$HTTP_RAW_POST_DATA</varname> 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.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<title><function>SoapServer::handle</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -65,14 +65,16 @@ $server->handle();
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapserver-construct" /></member>
<member><methodname>SoapServer::SoapServer</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

67
reference/soap/functions/soap-soapserver-setclass.xml → reference/soap/soapserver/setclass.xml
View file

@ -1,31 +1,28 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.soap-soapserver-setclass" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.setclass" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer->setClass</refname>
<refpurpose>
Sets class which will handle SOAP requests
</refpurpose>
<refname>SoapServer::setClass</refname>
<refpurpose>Sets the class which handles SOAP requests</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapServer</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>setClass</methodname>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapServer::setClass</methodname>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<para>
Exports all methods from specified class.
</para>
<para>
The object can be made persistent across request for a given PHP session
with the <xref linkend='function.soap-soapserver-setpersistence' /> method.
with the <methodname>SoapServer::setPersistence</methodname> method.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -50,51 +47,25 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<programlisting role="php">
<![CDATA[
<?php
class foo {
function foo()
{
}
}
$server->setClass("foo");
class bar {
function bar($x, $y)
{
}
}
$server->setClass("bar", $arg1, $arg2);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapserver-construct" /></member>
<member><xref linkend="function.soap-soapserver-addfunction" /></member>
<member><xref linkend="function.soap-soapserver-setpersistence" /></member>
<member><methodname>SoapServer::SoapServer</methodname></member>
<member><methodname>SoapServer::addFunction</methodname></member>
<member><methodname>SoapServer::setPersistence</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

76
reference/soap/soapserver/setobject.xml Normal file
View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.setobject" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer::setObject</refname>
<refpurpose>Sets the object which will be used to handle SOAP requests</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapServer::setObject</methodname>
<methodparam><type>string</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
This sets a specific object as the handler for SOAP requests, rather than just a class as in
<methodname>SoapServer::setClass</methodname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
The object to handle the requests.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>SoapServer::setClass</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:"../../../../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
-->

82
reference/soap/functions/soap-soapserver-setpersistence.xml → reference/soap/soapserver/setpersistence.xml
View file

@ -1,27 +1,33 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.soap-soapserver-setpersistence" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.setpersistence" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer->setPersistence</refname>
<refpurpose>
Sets persistence mode of SoapServer
</refpurpose>
<refname>SoapServer::setPersistence</refname>
<refpurpose>Sets SoapServer persistence mode</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapServer</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>setPersistence</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SoapServer::setPersistence</methodname>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
This function allows saving data between requests in a PHP session. It works only
with a server that exports functions from a class with
<xref linkend='function.soap-soapserver-setclass' />.
with a server that exports functions from a class with <methodname>SoapServer::setClass</methodname>
or <methodname>SoapServer::setObject</methodname>.
</para>
<note>
<para>
The persistence
<constant>SOAP_PERSISTENCE_SESSION</constant> makes persistent only object
of given class, but not the class static data. You may use $this->bar
instead of self::$bar.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -32,54 +38,30 @@
<para>
One of the <literal>SOAP_PERSISTENCE_XXX</literal> constants.
</para>
<para>
<literal>SOAP_PERSISTENCE_REQUEST</literal> - persist the object for the duration of a request.
</para>
<para>
<literal>SOAP_PERSISTENCE_SESSION</literal> - persist the object for the duration of a session.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<programlisting role="php">
<![CDATA[
<?php
$server->setPersistence(SOAP_PERSISTENCE_SESSION);
$server->setPersistence(SOAP_PERSISTENCE_REQUEST);
?>
]]>
</programlisting>
</example>
<note>
<simpara>
The persistence
<constant>SOAP_PERSISTENCE_SESSION</constant> makes persistent only object
of given class, but not the class static data. You may use $this->bar
instead of self::$bar.
</simpara>
</note>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapserver-construct" /></member>
<member><xref linkend="function.soap-soapserver-setclass" /></member>
<member><methodname>SoapServer::setClass</methodname></member>
<member><methodname>SoapServer::setObject</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

57
reference/soap/functions/soap-soapserver-construct.xml → reference/soap/soapserver/soapserver.xml
View file

@ -1,27 +1,25 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.soap-soapserver-construct" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapserver.soapserver" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapServer->__construct</refname>
<refpurpose>
SoapServer constructor
</refpurpose>
<refname>SoapServer::SoapServer</refname>
<refpurpose>SoapServer constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapServer</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam><type>mixed</type><parameter>wsdl</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<methodsynopsis>
<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>
@ -30,9 +28,9 @@
<term><parameter>wsdl</parameter></term>
<listitem>
<para>
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 <literal>uri</literal>
option.
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>
@ -57,19 +55,26 @@
(callback accepting one object parameter).
</para>
<para>
Other options are <literal>features</literal> and
<literal>cache_wsdl</literal>.
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.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<title><function>SoapServer::SoapServer</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -97,6 +102,16 @@ $server = new SoapServer("books.wsdl", array('classmap' => array('book' => "MyBo
</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

67
reference/soap/soapvar.xml Normal file
View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<phpdoc:classref xml:id="class.soapvar" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SoapVar class</title>
<titleabbrev>SoapVar</titleabbrev>
<partintro>
<!-- {{{ SoapVar intro -->
<section xml:id="soapvar.intro">
&reftitle.intro;
<para>
A class representing a variable or object for use with SOAP services.
</para>
</section>
<!-- }}} -->
<section xml:id="soapvar.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SoapVar</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SoapVar</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.soapvar')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.soap.entities.soapvar;
</phpdoc:classref>
<!-- 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:"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
-->

45
reference/soap/functions/soap-soapvar-construct.xml → reference/soap/soapvar/soapvar.xml
View file

@ -1,30 +1,28 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.soap-soapvar-construct" xmlns="http://docbook.org/ns/docbook">
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="soapvar.soapvar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SoapVar->__construct</refname>
<refpurpose>
SoapVar constructor
</refpurpose>
<refname>SoapVar::SoapVar</refname>
<refpurpose>SoapVar constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SoapVar</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam><type>mixed</type><parameter>data</parameter></methodparam>
<methodparam><type>int</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>
</constructorsynopsis>
</classsynopsis>
<methodsynopsis>
<methodname>SoapVar::SoapVar</methodname>
<methodparam><type>string</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>
@ -80,11 +78,12 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Some examples</title>
<title><function>SoapVar::SoapVar</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -107,15 +106,17 @@ $client->echoStruct(new SoapParam($soapstruct, "inputStruct"));
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.soap-soapclient-soapcall" /></member>
<member><xref linkend="function.soap-soapparam-construct" /></member>
<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

71
reference/soap/versions.xml
View file

@ -1,40 +1,59 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!--
Do NOT translate this file
-->
<!--
Example entries:
<function name='classname::methodname' from='PECL extname &gt;= 1.1'/>
<function name='functionname' from='PHP &gt;= 5.3.0'/>
<function name='functionname' from='PHP 5'/>
-->
<versions>
<function name='soap_encode_to_xml' from='PHP 5 &lt;= 5.1.6'/>
<function name='soap_encode_to_zval' from='PHP 5 &lt;= 5.1.6'/>
<function name='soapclient::__call' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__dorequest' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getfunctions' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getlastrequest' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getlastrequestheaders' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getlastresponse' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getlastresponseheaders' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__gettypes' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__setcookie' from='PHP 5 &gt;= 5.0.4'/>
<function name='soapclient::__setlocation' from='PHP 5 &gt;= 5.0.4'/>
<function name='soapclient::__setsoapheaders' from='PHP 5 &gt;= 5.0.5'/>
<!-- Functions -->
<function name='use_soap_error_handler' from='Unknown'/>
<function name='is_soap_fault' from='Unknown'/>
<!-- Methods -->
<function name='soapclient::soapclient' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__call' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__soapcall' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getlastrequest' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getlastresponse' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getlastrequestheaders' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getlastresponseheaders' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__getfunctions' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__gettypes' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__dorequest' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__setcookie' from='PHP 5 &gt;= 5.0.4'/>
<function name='soapclient::__setlocation' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapclient::__setsoapheaders' from='PHP 5 &gt;= 5.0.5'/>
<function name='soapfault::soapfault' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapheader::soapheader' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapparam::soapparam' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapvar::soapvar' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::soapserver' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::setpersistence' from='PHP 5 &gt;= 5.1.2'/>
<function name='soapserver::setclass' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::setobject' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::addfunction' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::getfunctions' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::handle' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::setclass' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::setobject' from='PHP 5 &gt;= 5.2.0'/>
<function name='soapserver::setpersistence' from='PHP 5 &gt;= 5.1.2'/>
<function name='soapserver::soapserver' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::fault' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapserver::addsoapheader' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapvar::soapvar' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::soapfault' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::__tostring' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::__clone' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::__construct' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::getmessage' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::getcode' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::getfile' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::getline' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::gettrace' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::getprevious' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapfault::gettraceasstring' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapparam::soapparam' from='PHP 5 &gt;= 5.0.1'/>
<function name='soapheader::soapheader' from='PHP 5 &gt;= 5.0.1'/>
</versions>
<!-- Keep this comment at the end of the file
@ -56,4 +75,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-->