XML-RPC usage notes in PHP

PHP integrates two Web Service communication protocol standards, XML-RPC and SOAP. The basic idea is to use XML-based HTTP remote calls to provide a standard mechanism, eliminating the need to establish a new protocol. In fact, this is very practical in actual development applications. For example, the PC client or the popular mobile phone client needs to communicate with the server. In this case, XML-RPC is a good solution. Here are some notes on how to use XML-RPC in PHP, although this method is not used much. The basic principle is that XML-RPC uses XML for communication. First, an RPC server is constructed to process XML-encapsulated requests passed from the RPC client, and the processing results are returned to the RPC client in the form of XML. The client then analyzes the XML to obtain the data it needs. The server side of XML-RPC must have ready-made functions for the client to call, and the functions and methods in the request submitted by the client must be consistent with those on the server side, otherwise the required results will not be obtained. First make sure your PHP supports the XML-RPC extension. If not, please install it. Place php_xmlrpc.dll in your PHP extension directory under Windows. Recompile PHP on Linux. Please add the –with-xmlrpc option when configuring. , because I am using Ubuntu, so just sudo apt-get install php5-xmlrpc. The server segment code is as follows, with detailed comments:

/* server.php
* @function 提供给RPC客户端调用的函数
* @param   string  $method 客户端需要调用的函数
* @param   array   $params 客户端需要调用的函数的参数数组
* return   string  返回调用结果
*/
function rpc_server_func($method, $params) {
$parameter = $params[0];
if ($parameter == "get") {
$return = 'This data by get method';
} else {
$return = 'Not specify method or params';
}
return $return;
}

//产生XML-RPC的服务器端
$xmlrpc_server = xmlrpc_server_create();
//注册一个服务器端调用的方法rpc_server，实际指向的是rpc_server_func函数
xmlrpc_server_register_method($xmlrpc_server, "rpc_server", "rpc_server_func");
//接受客户端POST过来的XML数据
$request = $HTTP_RAW_POST_DATA;
//执行调用客户端的XML请求后获取执行结果
$xmlrpc_response = xmlrpc_server_call_method($xmlrpc_server, $request, null);
//把函数处理后的结果XML进行输出
header('Content-Type: text/xml');
echo $xmlrpc_response;
//销毁XML-RPC服务器端资源
xmlrpc_server_destroy($xmlrpc_server);

/* client.php
* @function    提供给客户端进行连接XML-RPC服务器端的函数
* @param   string  $host  需要连接的主机
* @param   string  $port  连接主机的端口
* @param   string  $rpc_server XML-RPC服务器端文件
* @param   $request  封装的XML请求信息
* return   成功返回由服务器端返回的XML信息，失败返回false
*/
function rpc_client_call($host, $port, $rpc_server, $request) {
//打开指定的服务器端
$fp = fsockopen($host, $port);
//构造需要进行通信的XML-RPC服务器端的查询POST请求信息
$query = "POST $rpc_server HTTP/1.0\nUser_Agent: XML-RPC Client\nHost: " . $host . "\nContent-Type: text/xml\nContent-Length: " . strlen($request) . "\n\n" . $request . "\n";
//把构造好的HTTP协议发送给服务器，失败返回false
if (!fputs($fp, $query, strlen($query))) {
$errstr = "Write error";
return false;
}
//获取从服务器端返回的所有信息，包括HTTP头和XML信息
$contents = "";
while (!feof($fp)) {
$contents .= fgets($fp);
}
//关闭连接资源后返回获取的内容
fclose($fp);
return $contents;
}
//构造连接RPC服务器端的信息
$host = 'localhost';
$port = 80;
$rpc_server = 'server.php';
//把需要发送的XML请求进行编码成XML，需要调用的方法是rpc_server，参数是get
$request = xmlrpc_encode_request('rpc_server', 'get');
//调用rpc_client_call函数把所有请求发送给XML-RPC服务器端后获取信息
$response = rpc_client_call($host, $port, $rpc_server, $request);
//分析从服务器端返回的XML，去掉HTTP头信息，并且把XML转为PHP能识别的字符串
$split = "";
$xml = explode($split, $response);
$xml = $split . array_pop($xml);
$response = xmlrpc_decode($xml);
//输出从RPC服务器端获取的信息
print_r($response);

The XML is encoded into a PHP string through the xmlrpc_decode function for processing, and the entire Web Service interaction is completed. XML-RPC function reference:

xmlrpc_decode_request — Decode XML into PHP’s own type

xmlrpc_decode — Decode XML into PHP’s own type

xmlrpc_encode_request — Generate XML for PHP values

xmlrpc_encode — Generate XML for PHP values

xmlrpc_get_type — Get the type of xmlrpc for PHP value

xmlrpc_is_fault — Determines if an array value represents an XMLRPC fault

xmlrpc_parse_method_descriptions — Decode XML into a list of method descriptions

xmlrpc_server_add_introspection_data — Add self-describing documentation

xmlrpc_server_call_method — Parse the XML request and call the method

xmlrpc_server_create — Create an xmlrpc server

xmlrpc_server_destroy — Destroy server resources

xmlrpc_server_register_introspection_callback — Register a PHP function for document generation

xmlrpc_server_register_method — Register a PHP function to match the xmlrpc method name

xmlrpc_set_type — Set the type of xmlrpc, base64 or datetime for a PHP string value

The above introduces the XML-RPC usage notes in PHP, including relevant content. I hope it will be helpful to friends who are interested in PHP tutorials.