blob: c63ed44deb05afb9ddbb24eda5f0151a5eb42b70 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
<?php
/**
* @author Robin J. Rogge <rrogge@bigpoint.net>
* @link http://www.pradosoft.com/
* @copyright 2010 Bigpoint GmbH
* @license http://www.pradosoft.com/license/
* @since 3.2
* @package Prado\Web\Services
*/
namespace Prado\Web\Services;
/**
* TRpcApiProvider class
*
* TRpcApiProvider is an abstract class the can be subclasses in order to implement an
* api for a {@link TRpcService}. A subclass of TRpcApiProvider must implement the
* {@link registerMethods} method in order to declare the available methods, their
* names and the associated callback.
*
* <code>
* public function registerMethods()
* {
* return array(
* 'apiMethodName1' => array('method' => array($this, 'objectMethodName1')),
* 'apiMethodName2' => array('method' => array('ClassName', 'staticMethodName')),
* );
* }
* </code>
*
* In this example, two api method have been defined. The first refers to an object
* method that must be implemented in the same class, the second to a static method
* implemented in a 'ClassName' class.
* In both cases, the method implementation will receive the request parameters as its
* method parameters. Since the number of received parameters depends on
* external-supplied data, it's adviced to use php's func_get_args() funtion to
* validate them.
*
* Providers must be registered in the service configuration in order to be available,
* as explained in {@link TRpcService}'s documentation.
*
* @author Robin J. Rogge <rrogge@bigpoint.net>
* @package Prado\Web\Services
* @since 3.2
*/
abstract class TRpcApiProvider extends TModule
{
/**
* @var TRpcServer instance
*/
protected $rpcServer;
/**
* Must return an array of the available methods
* @abstract
*/
abstract public function registerMethods();
/**
* Constructor: informs the rpc server of the registered methods
*/
public function __construct(TRpcServer $rpcServer)
{
$this->rpcServer = $rpcServer;
foreach($this->registerMethods() as $_methodName => $_methodDetails)
$this->rpcServer->addRpcMethod($_methodName, $_methodDetails);
}
/**
* Processes the request using the server
* @return processed request
*/
public function processRequest()
{
return $this->rpcServer->processRequest();
}
/**
* @return rpc server instance
*/
public function getRpcServer()
{
return $this->rpcServer;
}
}
|
