<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Generates XML for a method request</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xmlrpc-decode.html">xmlrpc_decode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xmlrpc-encode.html">xmlrpc_encode</a></div>
<div class="up"><a href="ref.xmlrpc.html">XML-RPC Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.xmlrpc-encode-request" class="refentry">
<div class="refnamediv">
<h1 class="refname">xmlrpc_encode_request</h1>
<p class="verinfo">(PHP 4 >= 4.1.0, PHP 5)</p><p class="refpurpose"><span class="refname">xmlrpc_encode_request</span> — <span class="dc-title">Generates XML for a method request</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.xmlrpc-encode-request-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>xmlrpc_encode_request</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$method</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$params</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$output_options</code></span>
] )</div>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-function.xmlrpc-encode-request-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">method</code></em></span>
<dd>
<p class="para">
Name of the method to call.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">params</code></em></span>
<dd>
<p class="para">
Method parameters compatible with method signature.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">output_options</code></em></span>
<dd>
<p class="para">
Array specifying output options may contain (default values are
emphasised):
<ul class="itemizedlist">
<li class="listitem"><p class="para">output_type: php, <em class="emphasis">xml</em></p></li>
<li class="listitem"><p class="para">verbosity: no_white_space, newlines_only, <em class="emphasis">pretty</em></p></li>
<li class="listitem"><p class="para">escaping: cdata, <em class="emphasis">non-ascii, non-print, markup</em>
(may be a string with one value or an array with multiple values)</p></li>
<li class="listitem"><p class="para">version: simple, <em class="emphasis">xmlrpc</em>, soap 1.1, auto</p></li>
<li class="listitem"><p class="para">encoding: <em class="emphasis">iso-8859-1</em>, other character set supported by iconv</p></li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.xmlrpc-encode-request-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string containing the XML representation of the request.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.xmlrpc-encode-request-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5347">
<p><strong>Example #1 XMLRPC client functions example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$request </span><span style="color: #007700">= </span><span style="color: #0000BB">xmlrpc_encode_request</span><span style="color: #007700">(</span><span style="color: #DD0000">"method"</span><span style="color: #007700">, array(</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$context </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_context_create</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'http' </span><span style="color: #007700">=> array(<br /> </span><span style="color: #DD0000">'method' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"POST"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'header' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"Content-Type: text/xml"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'content' </span><span style="color: #007700">=> </span><span style="color: #0000BB">$request<br /></span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">$file </span><span style="color: #007700">= </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://www.example.com/xmlrpc"</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">$context</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$response </span><span style="color: #007700">= </span><span style="color: #0000BB">xmlrpc_decode</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$response </span><span style="color: #007700">&& </span><span style="color: #0000BB">xmlrpc_is_fault</span><span style="color: #007700">(</span><span style="color: #0000BB">$response</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">trigger_error</span><span style="color: #007700">(</span><span style="color: #DD0000">"xmlrpc: </span><span style="color: #0000BB">$response</span><span style="color: #007700">[</span><span style="color: #0000BB">faultString</span><span style="color: #007700">]</span><span style="color: #DD0000"> (</span><span style="color: #0000BB">$response</span><span style="color: #007700">[</span><span style="color: #0000BB">faultCode</span><span style="color: #007700">]</span><span style="color: #DD0000">)"</span><span style="color: #007700">);<br />} else {<br /> </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$response</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.xmlrpc-encode-request-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.stream-context-create.html" class="function" rel="rdfs-seeAlso">stream_context_create()</a> - Creates a stream context</span></li>
<li class="member"> <span class="function"><a href="function.file-get-contents.html" class="function" rel="rdfs-seeAlso">file_get_contents()</a> - Reads entire file into a string</span></li>
<li class="member"> <span class="function"><a href="function.xmlrpc-decode.html" class="function" rel="rdfs-seeAlso">xmlrpc_decode()</a> - Decodes XML into native PHP types</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xmlrpc-decode.html">xmlrpc_decode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xmlrpc-encode.html">xmlrpc_encode</a></div>
<div class="up"><a href="ref.xmlrpc.html">XML-RPC Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
