Add SoapClient->__setCookie() docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@177779 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2005-01-20 18:37:44 +00:00
parent 77e09afc42
commit 2e52786463
2 changed files with 86 additions and 1 deletions

View file

@ -0,0 +1,81 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.soap-soapclient-setcookie">
<refnamediv>
<refname>SoapClient->__setCookie()</refname>
<refpurpose>
Sets the cookie that will be sent with the SOAP request
</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>
<para>
Defines a cookie to be sent along with the SOAP requests.
</para>
<note>
<para>
Calling this method will affect all following calls to
<classname>SoapClient</classname> methods.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the cookie.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value of the cookie. If not specified, the cookie will be deleted.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</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
-->

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<reference id="ref.soap">
<title>SOAP Functions</title>
@ -79,6 +79,10 @@
<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>
</itemizedlist>
</section>
</section>