Source of: /manual/en/soapclient.setsoapheaders.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.soapclient.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'soapclient.setsoapheaders.php',
1 => 'SoapClient::__setSoapHeaders',
),
'up' =>
array (
0 => 'class.soapclient.php',
1 => 'The SoapClient class',
),
'prev' =>
array (
0 => 'soapclient.setlocation.php',
1 => 'SoapClient::__setLocation',
),
'next' =>
array (
0 => 'soapclient.soapcall.php',
1 => 'SoapClient::__soapCall',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="soapclient.setsoapheaders" class="refentry">
<div class="refnamediv">
<h1 class="refname">SoapClient::__setSoapHeaders</h1>
<p class="verinfo">(PHP 5 >= 5.0.5)</p><p class="refpurpose"><span class="refname">SoapClient::__setSoapHeaders</span> — <span class="dc-title">Sets SOAP headers for subsequent calls.</span></p>
</div>
<a name="soapclient.setsoapheaders.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><b>SoapClient::__setSoapHeaders</b></span>
([ <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$soapheaders</tt></span>
] )</div>
<p class="para rdfs-comment">
Defines headers to be sent along with the SOAP requests.
</p>
<blockquote><p><b class="note">Note</b>:
Calling this method will replace any previous values.
<br />
</p></blockquote>
</div>
<a name="soapclient.setsoapheaders.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">soapheaders</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The headers to be set. If not specified, the headers will be deleted.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="soapclient.setsoapheaders.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="soapclient.setsoapheaders.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>SoapClient::__setSoapHeaders()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SoapClient</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'location' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"http://localhost/soap.php"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'uri' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"http://test-uri/"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$header </span><span style="color: #007700">= new </span><span style="color: #0000BB">SoapHeader</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://soapinterop.org/echoheader/'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'echoMeStringRequest'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'hello world'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">__setSoapHeaders</span><span style="color: #007700">(</span><span style="color: #0000BB">$header</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">__soapCall</span><span style="color: #007700">(</span><span style="color: #DD0000">"echoVoid"</span><span style="color: #007700">, </span><span style="color: #0000BB">null</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
<p class="para">
</p><div class="example">
<p><b>Example #2 Set Multiple Headers</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SoapClient</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'location' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"http://localhost/soap.php"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'uri' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"http://test-uri/"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$headers </span><span style="color: #007700">= array();<br /><br /></span><span style="color: #0000BB">$headers</span><span style="color: #007700">[] = new </span><span style="color: #0000BB">SoapHeader</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://soapinterop.org/echoheader/'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'echoMeStringRequest'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'hello world'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$headers</span><span style="color: #007700">[] = new </span><span style="color: #0000BB">SoapHeader</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://soapinterop.org/echoheader/'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'echoMeStringRequest'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'hello world again'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">__setSoapHeaders</span><span style="color: #007700">(</span><span style="color: #0000BB">$headers</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">__soapCall</span><span style="color: #007700">(</span><span style="color: #DD0000">"echoVoid"</span><span style="color: #007700">, </span><span style="color: #0000BB">null</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
</div><?php manual_footer(); ?>