Class: XML_RPC2_Server_Callhandler_Class

Source Location: /XML_RPC2-1.0.5/XML/RPC2/Server/CallHandler/Class.php

Class Overview

XML_RPC2_Server_CallHandler
   |
   --XML_RPC2_Server_Callhandler_Class

This class is a server call handler which exposes a classe's static public methods.

Author(s):

Sergio Carvalho <sergio.carvalho at portugalmail.com>

Copyright:

2004-2006 Sergio Carvalho

Inherited Variables

Class: XML_RPC2_Server_CallHandler

XML_RPC2_Server_CallHandler::$methods

Inherited Methods

Class: XML_RPC2_Server_CallHandler

XML_RPC2_Server_CallHandler::addMethod(): method appender
XML_RPC2_Server_CallHandler::getMethod(): method getter
XML_RPC2_Server_CallHandler::getMethods(): methods getter

Class Details

[line 90]
This class is a server call handler which exposes a classe's static public methods.

XML_RPC2_Server_Callhandler_Class is the preferred call handler to use when you are designing your XML-RPC server from the ground up. Usage is quite simple:

Create a class holding all of the XML-RPC server's exported procedures as public static methods (the interface class).
PhpDoc the classes' methods, including at least method signature (params and return types) and short description.
Use the XML_RPC2 factory method to create a server based on the interface class.

A simple example:

 /**
  * echoecho echoes the message received
  *
  * @param string  Message
  * @return string The echo
  */
 class EchoServer {
     public static function echoecho($string)
     {
         return $string;
     }
 }
 
 require_once 'XML/RPC2/Server.php';
 $server = XML_RPC2_Server::create('EchoServer');
 $server->handleCall();

Use this call handler if you have designed your xml-rpc external interface as a set of public class methods on a given class. If, on the other hand, you intend to export an already existing class, it may be that not all of the methods you want to export are static. In that case, it is probably best to use XML_RPC2_Server_Callhandler_Instance instead.

Author: Sergio Carvalho <sergio.carvalho@portugalmail.com>
Copyright: 2004-2006 Sergio Carvalho
See: XML_RPC2_Server::create
See: XML_RPC2_Server_Callhandler_Instance
Link: http://pear.php.net/package/XML_RPC2
License: LGPL License 2.1

[ Top ]

Method Detail

__construct (Constructor) [line 115]

XML_RPC2_Server_Callhandler_Class __construct(
string
$className, string
$defaultPrefix)

XML_RPC2_Server_Callhandler_Class Constructor. Creates a new call handler exporting the give static class' methods

Before using this constructor, take a look at XML_RPC2_Server::create. The factory method is usually a quicker way of instantiating the server and its call handler.

See: XML_RPC2_Server::create()
Access: public

Parameters:

string	`$className`	—	The Target class. Calls will be made on this class
string	`$defaultPrefix`	—	Default prefix to prepend to all exported methods (defaults to '')

[ Top ]

__call [line 138]

mixed __call(
string
$methodName, array
$parameters)

__call catchall. Delegate the method call to the target class, and return its result

Return: Whatever the target method returned
Access: public

Parameters:

string	`$methodName`	—	Name of method to call
array	`$parameters`	—	Array of parameters for call

[ Top ]