Ref/xmlrpc-Phpdoc专题
xmlrpc_decode_request
将 XML 译码为 PHP 本身的类型
说明
mixed <span
class="methodname">xmlrpc_decode_request ( <span
class="methodparam">string $xml ,
string
&$method [, <span
class="type">string $encoding ] )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_decode
将 XML 译码为 PHP 本身的类型
说明
mixed <span
class="methodname">xmlrpc_decode ( <span
class="methodparam">string $xml [,
string
$encoding = "iso-8859-1" ] )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
参数
xml
XML response returned by XMLRPC method.
encoding
Input encoding supported by iconv.
返回值
Returns either an array, or an integer, or a string, or a boolean according to the response returned by the XMLRPC method.
范例
See example by xmlrpc_encode_request.
参见
- xmlrpc_encode_request
- xmlrpc_is_fault
xmlrpc_encode_request
为 PHP 的值生成 XML
说明
string <span
class="methodname">xmlrpc_encode_request ( <span
class="methodparam">string $method ,
mixed
$params [, <span
class="type">array $output_options ] )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
参数
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
返回值
Returns a string containing the XML representation of the request.
范例
示例 #1 XMLRPC client functions example
<?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 ($response && xmlrpc_is_fault($response)) {
trigger_error("xmlrpc: $response[faultString] ($response[faultCode])");
} else {
print_r($response);
}
?>参见
- stream_context_create
- file_get_contents
- xmlrpc_decode
xmlrpc_encode
为 PHP 的值生成 XML
说明
string <span
class="methodname">xmlrpc_encode ( <span
class="methodparam">mixed $value )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_get_type
为 PHP 的值获取 xmlrpc 的类型
说明
string <span
class="methodname">xmlrpc_get_type ( <span
class="methodparam">mixed $value )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
该函数对于 base64 与日期时间字符串特别有用。
参数
value
PHP value
返回值
Returns the XML-RPC type.
范例
示例 #1 XML-RPC type example
<?php
echo xmlrpc_get_type(null) . "\n"; // base64
echo xmlrpc_get_type(false) . "\n"; // boolean
echo xmlrpc_get_type(1) . "\n"; // int
echo xmlrpc_get_type(1.0) . "\n"; // double
echo xmlrpc_get_type("") . "\n"; // string
echo xmlrpc_get_type(array()) . "\n"; // array
echo xmlrpc_get_type(new stdClass) . "\n"; // array
echo xmlrpc_get_type(STDIN) . "\n"; // int
?>参见
- xmlrpc_set_type
xmlrpc_is_fault
Determines if an array value represents an XMLRPC fault
说明
bool <span
class="methodname">xmlrpc_is_fault ( <span
class="methodparam">array $arg )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
参数
arg
Array returned by xmlrpc_decode.
返回值
Returns true if the argument means fault, false otherwise.
Fault description is available in $arg["faultString"], fault code is
in $arg["faultCode"].
范例
See example by xmlrpc_encode_request.
参见
- xmlrpc_decode
xmlrpc_parse_method_descriptions
将 XML 译码成方法描述的列表
说明
array <span
class="methodname">xmlrpc_parse_method_descriptions ( <span
class="methodparam">string $xml )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_server_add_introspection_data
添加自我描述的文档
说明
int <span
class="methodname">xmlrpc_server_add_introspection_data (
resource
$server , <span
class="type">array $desc )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_server_call_method
解析 XML 请求同时调用方法
说明
string <span
class="methodname">xmlrpc_server_call_method ( <span
class="methodparam">resource $server
, string
$xml , <span
class="type">mixed $user_data [, <span
class="methodparam">array
$output_options ] )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_server_create
创建一个 xmlrpc 服务端
说明
resource <span class="methodname">xmlrpc_server_create ( <span class="methodparam">void )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_server_destroy
销毁服务端资源
说明
int <span
class="methodname">xmlrpc_server_destroy ( <span
class="methodparam">resource $server
)
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_server_register_introspection_callback
注册一个 PHP 函数用于生成文档
说明
bool <span
class="methodname">xmlrpc_server_register_introspection_callback
( resource
$server , <span
class="type">string $function )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_server_register_method
注册一个 PHP 函数用于匹配 xmlrpc 方法名
说明
bool <span
class="methodname">xmlrpc_server_register_method ( <span
class="methodparam">resource $server
, string
$method_name , <span
class="type">string $function )
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
Warning
本函数还未编写文档，仅有参数列表。
xmlrpc_set_type
为一个 PHP 字符串值设置 xmlrpc 的类型、base64 或日期时间
说明
bool <span
class="methodname">xmlrpc_set_type ( <span
class="methodparam">string &$value ,
string
$type )
为一个 PHP 字符串值设置 xmlrpc 的类型、base64 或日期时间
Warning
此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。
参数
value
Value to set the type
type
'base64' or 'datetime'
返回值
成功时返回 true， 或者在失败时返回 false。 If successful,
value is converted to an object.
范例
示例 #1 A xmlrpc_set_type example
<?php
$params = date("Ymd\TH:i:s", time());
xmlrpc_set_type($params, 'datetime');
echo xmlrpc_encode($params);
?>以上例程的输出类似于：
<?xml version="1.0" encoding="utf-8"?>
<params>
<param>
<value>
<dateTime.iso8601>20090322T23:43:03</dateTime.iso8601>
</value>
</param>
</params>错误／异常
Issues E_WARNING with type unsupported by XMLRPC.
目录
- xmlrpc_decode_request — 将 XML 译码为 PHP 本身的类型
- xmlrpc_decode — 将 XML 译码为 PHP 本身的类型
- xmlrpc_encode_request — 为 PHP 的值生成 XML
- xmlrpc_encode — 为 PHP 的值生成 XML
- xmlrpc_get_type — 为 PHP 的值获取 xmlrpc 的类型
- xmlrpc_is_fault — Determines if an array value represents an XMLRPC fault
- xmlrpc_parse_method_descriptions — 将 XML 译码成方法描述的列表
- xmlrpc_server_add_introspection_data — 添加自我描述的文档
- xmlrpc_server_call_method — 解析 XML 请求同时调用方法
- xmlrpc_server_create — 创建一个 xmlrpc 服务端
- xmlrpc_server_destroy — 销毁服务端资源
- xmlrpc_server_register_introspection_callback — 注册一个 PHP 函数用于生成文档
- xmlrpc_server_register_method — 注册一个 PHP 函数用于匹配 xmlrpc 方法名
- xmlrpc_set_type — 为一个 PHP 字符串值设置 xmlrpc 的类型、base64 或日期时间