Class: XML_RPC2_Server_Callhandler_Instance

Source Location: /XML_RPC2-1.1.2/XML/RPC2/Server/CallHandler/Instance.php

Class Overview

XML_RPC2_Server_CallHandler
   |
   --XML_RPC2_Server_Callhandler_Instance

This class is a server call handler which exposes an instance's 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 88]
This class is a server call handler which exposes an instance's public methods.

XML_RPC2_Server_Callhandler_Instance is the preferred call handler to use when you just need to quickly expose an already existing object. If designing a remote API from the ground up, it's best to use XML_RPC2_Server_Callhandler_Class instead.

Usage is simple:

PhpDoc the 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:

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

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

[ Top ]

Method Detail

__construct (Constructor) [line 113]

XML_RPC2_Server_Callhandler_Instance __construct(
object The
$instance, string
$defaultPrefix)

XML_RPC2_Server_Callhandler_Class Constructor. Creates a new call handler exporting the given object 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:

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

[ Top ]

__call [line 136]

mixed __call(
string
$methodName, array
$parameters)

__call catchall. Delegate the method call to the target object, 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 ]