summaryrefslogtreecommitdiff
path: root/libs/jsonrpc/src/JsonRPC/Client.php
diff options
context:
space:
mode:
Diffstat (limited to 'libs/jsonrpc/src/JsonRPC/Client.php')
-rw-r--r--libs/jsonrpc/src/JsonRPC/Client.php198
1 files changed, 198 insertions, 0 deletions
diff --git a/libs/jsonrpc/src/JsonRPC/Client.php b/libs/jsonrpc/src/JsonRPC/Client.php
new file mode 100644
index 00000000..73ab1342
--- /dev/null
+++ b/libs/jsonrpc/src/JsonRPC/Client.php
@@ -0,0 +1,198 @@
+<?php
+
+namespace JsonRPC;
+
+use Exception;
+use JsonRPC\Request\RequestBuilder;
+use JsonRPC\Response\ResponseParser;
+
+/**
+ * JsonRPC client class
+ *
+ * @package JsonRPC
+ * @author Frederic Guillot
+ */
+class Client
+{
+ /**
+ * If the only argument passed to a function is an array
+ * assume it contains named arguments
+ *
+ * @access private
+ * @var boolean
+ */
+ private $isNamedArguments = true;
+
+ /**
+ * Do not immediately throw an exception on error. Return it instead.
+ *
+ * @access public
+ * @var boolean
+ */
+ private $returnException = false;
+
+ /**
+ * True for a batch request
+ *
+ * @access private
+ * @var boolean
+ */
+ private $isBatch = false;
+
+ /**
+ * Batch payload
+ *
+ * @access private
+ * @var array
+ */
+ private $batch = array();
+
+ /**
+ * Http Client
+ *
+ * @access private
+ * @var HttpClient
+ */
+ private $httpClient;
+
+ /**
+ * Constructor
+ *
+ * @access public
+ * @param string $url Server URL
+ * @param bool $returnException Return exceptions
+ * @param HttpClient $httpClient HTTP client object
+ */
+ public function __construct($url = '', $returnException = false, HttpClient $httpClient = null)
+ {
+ $this->httpClient = $httpClient ?: new HttpClient($url);
+ $this->returnException = $returnException;
+ }
+
+ /**
+ * Arguments passed are always positional
+ *
+ * @access public
+ * @return $this
+ */
+ public function withPositionalArguments()
+ {
+ $this->isNamedArguments = false;
+ return $this;
+ }
+
+ /**
+ * Get HTTP Client
+ *
+ * @access public
+ * @return HttpClient
+ */
+ public function getHttpClient()
+ {
+ return $this->httpClient;
+ }
+
+ /**
+ * Set username and password
+ *
+ * @access public
+ * @param string $username
+ * @param string $password
+ * @return $this
+ */
+ public function authentication($username, $password)
+ {
+ $this->httpClient
+ ->withUsername($username)
+ ->withPassword($password);
+
+ return $this;
+ }
+
+ /**
+ * Automatic mapping of procedures
+ *
+ * @access public
+ * @param string $method Procedure name
+ * @param array $params Procedure arguments
+ * @return mixed
+ */
+ public function __call($method, array $params)
+ {
+ if ($this->isNamedArguments && count($params) === 1 && is_array($params[0])) {
+ $params = $params[0];
+ }
+
+ return $this->execute($method, $params);
+ }
+
+ /**
+ * Start a batch request
+ *
+ * @access public
+ * @return Client
+ */
+ public function batch()
+ {
+ $this->isBatch = true;
+ $this->batch = array();
+ return $this;
+ }
+
+ /**
+ * Send a batch request
+ *
+ * @access public
+ * @return array
+ */
+ public function send()
+ {
+ $this->isBatch = false;
+ return $this->sendPayload('['.implode(', ', $this->batch).']');
+ }
+
+ /**
+ * Execute a procedure
+ *
+ * @access public
+ * @param string $procedure Procedure name
+ * @param array $params Procedure arguments
+ * @param array $reqattrs
+ * @param string|null $requestId Request Id
+ * @param string[] $headers Headers for this request
+ * @return mixed
+ */
+ public function execute($procedure, array $params = array(), array $reqattrs = array(), $requestId = null, array $headers = array())
+ {
+ $payload = RequestBuilder::create()
+ ->withProcedure($procedure)
+ ->withParams($params)
+ ->withRequestAttributes($reqattrs)
+ ->withId($requestId)
+ ->build();
+
+ if ($this->isBatch) {
+ $this->batch[] = $payload;
+ return $this;
+ }
+
+ return $this->sendPayload($payload, $headers);
+ }
+
+ /**
+ * Send payload
+ *
+ * @access private
+ * @throws Exception
+ * @param string $payload
+ * @param string[] $headers
+ * @return Exception|Client
+ */
+ private function sendPayload($payload, array $headers = array())
+ {
+ return ResponseParser::create()
+ ->withReturnException($this->returnException)
+ ->withPayload($this->httpClient->execute($payload, $headers))
+ ->parse();
+ }
+}