xmlrpc_server_register_method
(PHP 4 >= 4.1.0, PHP 5)
xmlrpc_server_register_method — Регистрирует функцию PHP к методу ресурса, соответствующему method_name
Описание
bool xmlrpc_server_register_method
( resource
$server
, string $method_name
, string $function
)Внимание
Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, ее имя и относящаяся к ней документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию на свой страх и риск.
Внимание
К настоящему времени эта функция еще не была документирована; для ознакомления доступен только список аргументов.
- xmlrpc_decode_request
- xmlrpc_decode
- xmlrpc_encode_request
- xmlrpc_encode
- xmlrpc_get_type
- xmlrpc_is_fault
- xmlrpc_parse_method_descriptions
- xmlrpc_server_add_introspection_data
- xmlrpc_server_call_method
- xmlrpc_server_create
- xmlrpc_server_destroy
- xmlrpc_server_register_introspection_callback
- xmlrpc_server_register_method
- xmlrpc_set_type
Коментарии
Here is an example how to register a class methode:
xml_rpc_server_register_methode($xmlrpc_server, "foo", array(&$bar, "foo_func"));
where $bar is the instance of your class and foo_func a methode of this class. Don't forget the '&'!
hope this may be useful...
Chrigu
In case its not completely obvious what Chrigu meant,
You can register a method inside your class by doing the following:
xml_rpc_server_register_methode($xmlrpc_server, "myClientCall", array(&$this, "handleClientCallFunc"));
where $this == the magic class $this. =)
Remember that you can't do like Chrigu and Nate said if you want to add methods from a static class (Hence you can't create any instances of it).
A workaround is to create lambda functions calling the
methods:
// Our static handler class
static class MyHandler
{
public function getPrice($item)
{
$prices = array("apple" => 4, "orange" => 5);
return $prices[$item];
}
public function buy($item, $number)
{
$price = self::getPrice($item) * $number;
do_thing_to_sell_the_item();
return $price;
}
}
// Use reflection to get method names and parameters
$mirror = new ReflectionClass("MyHandler");
foreach ($mirror->getMethods() as $method)
{
// Create new "lambda" function for each method
// Generate argument list
$args = array();
foreach ($method->getParameters() as $param)
{
$args[] = '$'.$param->getName();
}
$args = implode(',', $args);
// Generate code
$methodname = $method->getName();
$code = "return {$real_class}::{$methodname}({$args});";
// Create function, retrieve function name
$function_name = create_function($args, $code);
// Register the function
xmlrpc_server_register_method($myserver, $methodname, $function_name);
}
To register a callback to a 'static' function within the same class, consider a syntax like the following:<code>
$callback = array (__CLASS__, "my_function_name");
xmlrpc_server_register_method($xmlrpc_server, "my_function", $callback);
</code>
Doing it this way makes it easier to rename your class later.
prototype of registered function:
function method_impl(string $method_name, array $params, array $user_data);
$method_name
the public method name, known by calling client
$params
parameters specified by calling client
$user_data
any local data, passed by `xmlrpc_server_call_method'
To have an xmlrpc fault response programatically generated by the server, the php function registered as method handler must return an array containing a FaultCode and a FaultString members.
function $myfunc($methodname, $vals, $extra_data)
{
...
return array('faultCode' => 666, 'faultString' => 'DOH!');
}
Note 1: even if you add introspection data via calls to `xmlrpc_server_register_introspection_callback` or `xmlrpc_server_add_introspection_data`, the server will not validate for you the number or type of received parameters.
This means that you have to implement all required validation of the received parameters in your php function.
Note 2: take care about dealing with base64 and datetime values in the received parameters: those are not automatically transformed into php scalar values, but into stdClass objects with members `xmlrpc_type` and `scalar`