Zend XMLRPC服务执行/调用类

Question

I have a Class the runs a process by itself

Pseudo Class

class MyClass {
  private $x;
  private $y

  // filename is INI file, each project have its own INI file
  public function __construct($filename) {
    // read and set value from INI file
    // set some default values here as well
  }

  /**
   * Start Process
   *
   * @param 
   * @return
   */
  public function startProcess() {
    // run process here
    $y = $this->getX(); // and so on
    echo "Process Started: ".$y."
";
  }
  // This is the change for the XMLRPC
  /*
  public function startProcess($value) {
    // run process here
    echo "Process Started: ".$value."
";
  }
  */

  /**
   * Set X
   *
   * @param $x
   * @return
   */
  private function setX($x) {
    $this->x = $x;
  }

  /**
   * Get X
   *
   * @param 
   * @return $x
   */
  private function getX() {
    return $this->x;
  }

  // and so on
}

To execute the class I would do something like this

include('MyClass.php');

$process = new MyClass('file.ini');
$process->setX('blah');
$process->startProcess();

Now I want this to be initialized by a XMLRPC call where I would just pass it a variable in the method call. I was following this tutorial but I'm not sure if I can, here is what I'm trying. Now instead of setting X before hand I'm just going to pass it to the startProcess function

XMLRPC Server:

ini_set("include_path", "/usr/share/php/libzend-framework-php");
require_once('Zend/XmlRpc/Server.php');

/**
 * Start Process Wrapper
 * 
 * @param 
 * @return 
 */
function startProcessWrapper($value) {
    include('MyClass.php'); // I have change the startProcess() to take a variable

    $process = new MyClass('file.ini');
    $process->startProcess('passing x here');
}

$server = new Zend_XmlRpc_Server();
$server->addFunction('startProcessWrapper', 'webservice');
echo $server->handle();

XMLRPC Client:

ini_set("include_path", "/usr/share/php/libzend-framework-php");
require_once('Zend/XmlRpc/Client.php');

$server = new Zend_XmlRpc_Client('http://localhost/xmlrpc_server.php');
$client = $server->getProxy(); 

$request = array(
  array(
    'methodName' => 'system.listMethods', 
    'params'     => array() 
  ), 
  array( 
    'methodName' => 'system.methodHelp', 
    'params'     => array('webservice.startProcess') 
  ),  
  array( 
    'methodName' => 'webservice.startProcess', 
    'params'     => array('123456') 
  ));

  $response = $client->system->multicall($request); 
  echo print_r($response,true);

Here is the response I get:

Array
(
    [0] => Array
        (
            [0] => system.listMethods
            [1] => system.methodHelp
            [2] => system.methodSignature
            [3] => system.multicall
            [4] => webservice.startProcess
        )

    [1] => Start Process Wrapper
    [2] => Array
        (
            [faultCode] => 623
            [faultString] => Calling parameters do not match signature
        )

)

Why doesn't this work? Just trying to find a way for XMLRPC to kick off my class process, suggestions?

Answer 1

Ok so after much debugging my code I found that my docblock declaration was incorrect.

For each public function in the class you need to have a docblock that defines the parameters and return data type(s).

Example of what I had:

  /**
   * Set X
   *
   * @param $x
   * @return
   */
  public function setX($x) {
    $this->x = $x;
  }

Example of what it should be:

  /**
   * Set X, you can give more description here for help functionality
   *
   * @param string
   * @return
   */
  public function setX($x) {
    $this->x = $x;
  }

Hope this helps someone