One class per file: framework/Web/Services

1 files changed, 86 insertions, 0 deletions

diff --git a/framework/Web/Services/TRpcApiProvider.php b/framework/Web/Services/TRpcApiProvider.php
new file mode 100644
index 00000000..6ea1abfc
--- /dev/null
+++ b/framework/Web/Services/TRpcApiProvider.php
@@ -0,0 +1,86 @@
+<?php
+/**
+ * @author Robin J. Rogge <rrogge@bigpoint.net>
+ * @link http://www.pradosoft.com/
+ * @copyright 2010 Bigpoint GmbH
+ * @license http://www.pradosoft.com/license/
+ * @version $Id$
+ * @since 3.2
+ * @package System.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>
+ * @version $Id$
+ * @package System.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;
+	}
+}
\ No newline at end of file