php-doc-en/reference/soap/soapheader/construct.xml
Côme Chilliet e64ea89bbe Remove PHP4 constructors from ext/soap documentation
Contructors were still documented as aliases to classname::classname
 with the real documentation in classname::classname.

Closes GH-332.
2021-01-22 14:26:20 +01:00

130 lines
3.6 KiB
XML

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