xmlrpc_encode_request

Generates XML for a method request (PHP 4 >= 4.0.7, PHP 5)
string xmlrpc_encode_request ( string method, mixed params [, array output_options] )

Warning:

This function is EXPERIMENTAL. The behaviour of this function, the name of this function, and anything else documented about this function may change without notice in a future release of PHP. Use this function at your own risk.

Parameters

method

Name of the method to call.

params

Method parameters compatible with method signature.

output_options

Array specifying output options may contain (default values are emphasised):

output_type: php, xml
verbosity: no_white_space, newlines_only, pretty
escaping: cdata, non-ascii, non-print, markup (may be a string with one value or an array with multiple values)
version: simple, xmlrpc, soap 1.1, auto
encoding: iso-8859-1, other character set supported by iconv

Return Values

Returns a string containing the XML representation of the request.

Examples

Example 2647. XMLRPC client functions example

copy to clipboard

<?php

$request = xmlrpc_encode_request("method", array(1, 2, 3));
$context = stream_context_create(array('http' => array(

    'method' => "POST",

    'header' => "Content-Type: text/xml",

    'content' => $request
)));
$file = file_get_contents("http://www.example.com/xmlrpc", false, $context);
$response = xmlrpc_decode($file);

if (xmlrpc_is_fault($response)) {

    trigger_error("xmlrpc: $response[faultString] ($response[faultCode])");

} else {

    print_r($response);

}
?>

See Also

stream_context_create()

file_get_contents()

xmlrpc_decode()

Related Examples ( Source code ) » xmlrpc_encode_request

Code Examples / Notes » xmlrpc_encode_request

This function should be used by an XML-RPC client to create an XML payload for an XML-RPC request; <?php $params = "system.methodSignature"; $method = "system.methodHelp"; $request = xmlrpc_encode_request($method,$params); echo ( $request ); ?> Produces; <?xml version='1.0' encoding="iso-8859-1" ?> <methodCall> <methodName>system.methodHelp</methodName> <params> <param> <value> <string>system.methodSignature</string> </value> </param> </params> </methodCall> The second argument recognises the type of variable and generates the correct XML-RPC structure. See xmlrpc_encode() for more details.

Simple OO client with function Overload : the php metho test_helloworld is translated to xmlrpc method test.helloworld. class RpcClient { private $_methods; private $_context; private $_url; function __construct ($url, $user, $passwd) { $auth = base64_encode(sprintf('%s:%s', $user,$passwd)); $this->_context = stream_context_create(array( 'http' => array( 'method' => 'POST', 'header' => "Content-Type: text/xml\r\n". "Authorization: Basic $auth" , ) )); $this->_url = $url; $this->registerMethod ("Test_HelloWorld"); } function __call($methodName, $params) { if (array_key_exists($methodName,$this->_methods)) { // on appelle la fonction RPC $m = str_replace('_', '.', $methodName); $r = xmlrpc_encode_request($m, $params,array('verbosity'=>'newlines_only')); $c = $this->_context; stream_context_set_option($c,'http','content',$r); $f = file_get_contents($this->_url,false,$c); $resp = xmlrpc_decode($f); return $resp; } else { // on appelle la fonction de l'objet call_user_method_array($methodName, $this,$params); } } private function registerMethod ($method) { $this->_methods[$method] = true; } }

Binary strings (set with xmlrpc_set_type) go into a <base64>...</base64> block like you'd expect. But after every 80th character, this function inserts the XML entity "
", which is a Unicode newline, as if to cause a line-wrap, which is admittedly silly. Silly though it may be, it causes real problems for some XML-RPC servers, such as http://jakarta.apache.org/xmlrpc/ (nee Helma). Stripping out those entities with something like $req = preg_replace('/
/', '', xmlrpc_encode_request("my.method", $args)); works around the problem.

xmlrpc_encode_request

Generates XML for a method request (PHP 4 >= 4.0.7, PHP 5) string xmlrpc_encode_request ( string method, mixed params [, array output_options] )

Parameters

Return Values

Examples

Example 2647. XMLRPC client functions example

Related Examples ( Source code ) » xmlrpc_encode_request

Code Examples / Notes » xmlrpc_encode_request

Change Language

Generates XML for a method request (PHP 4 >= 4.0.7, PHP 5)
string xmlrpc_encode_request ( string method, mixed params [, array output_options] )