Added a ClientInterface (#1249)

* Added a ClientInterface

* Moved phpdoc in ClientInterface

Author: ezimuel

src/Client.php

@@ -25,7 +25,7 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Log\LoggerInterface;
 
-final class Client
+final class Client implements ClientInterface
 {
     const CLIENT_NAME = 'es';
     const VERSION = '8.4.0';
@@ -68,11 +68,17 @@ public function __construct(
         $this->defaultTransportSettings($this->transport);
     }
 
+    /**
+     * @inheritdoc
+     */
     public function getTransport(): Transport
     {
         return $this->transport;
     }
 
+    /**
+     * @inheritdoc
+     */
     public function getLogger(): LoggerInterface
     {
         return $this->logger;
@@ -87,7 +93,7 @@ protected function defaultTransportSettings(Transport $transport): void
     }
 
     /**
-     * Set the asyncronous HTTP request
+     * @inheritdoc
      */
     public function setAsync(bool $async): self
     {
@@ -96,15 +102,15 @@ public function setAsync(bool $async): self
     }
 
     /**
-     * Get the asyncronous HTTP request setting
+     * @inheritdoc
      */
     public function getAsync(): bool
     {
         return $this->async;
     }
 
     /**
-     * Enable or disable the x-elastic-client-meta header
+     * @inheritdoc
      */
     public function setElasticMetaHeader(bool $active): self
     {
@@ -113,15 +119,15 @@ public function setElasticMetaHeader(bool $active): self
     }
 
     /**
-     * Get the status of x-elastic-client-meta header
+     * @inheritdoc
      */
     public function getElasticMetaHeader(): bool
     {
         return $this->elasticMetaHeader;
     }
 
     /**
-     * Enable or disable the response Exception
+     * @inheritdoc
      */
     public function setResponseException(bool $active): self
     {
@@ -130,18 +136,15 @@ public function setResponseException(bool $active): self
     }
 
     /**
-     * Get the status of response Exception
+     * @inheritdoc
      */
     public function getResponseException(): bool
     {
         return $this->responseException;
     }
 
     /**
-     * Send the HTTP request using the Elastic Transport.
-     * It manages syncronous and asyncronus requests using Client::getAsync()
-     * 
-     * @return Elasticsearch|Promise
+     * @inheritdoc
      */
     public function sendRequest(RequestInterface $request)
     {   

src/ClientInterface.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * Elasticsearch PHP Client
+ *
+ * @link      https://github.com/elastic/elasticsearch-php
+ * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
+ * @license   https://opensource.org/licenses/MIT MIT License
+ *
+ * Licensed to Elasticsearch B.V under one or more agreements.
+ * Elasticsearch B.V licenses this file to you under the MIT License.
+ * See the LICENSE file in the project root for more information.
+ */
+declare(strict_types = 1);
+
+namespace Elastic\Elasticsearch;
+
+use Elastic\Elasticsearch\Response\Elasticsearch;
+use Elastic\Transport\Transport;
+use Http\Promise\Promise;
+use Psr\Http\Message\RequestInterface;
+use Psr\Log\LoggerInterface;
+
+interface ClientInterface
+{
+    /**
+     * Get the Elastic\Transport\Transport
+     */
+    public function getTransport(): Transport;
+
+    /**
+     * Get the PSR-3 logger
+     */
+    public function getLogger(): LoggerInterface;
+
+     /**
+     * Set the asyncronous HTTP request
+     */
+    public function setAsync(bool $async): self;
+
+    /**
+     * Get the asyncronous HTTP request setting
+     */
+    public function getAsync(): bool;
+
+    /**
+     * Enable or disable the x-elastic-client-meta header
+     */
+    public function setElasticMetaHeader(bool $active): self;
+
+    /**
+     * Get the status of x-elastic-client-meta header
+     */
+    public function getElasticMetaHeader(): bool;
+
+     /**
+     * Enable or disable the response Exception
+     */
+    public function setResponseException(bool $active): self;
+
+     /**
+     * Get the status of response Exception
+     */
+    public function getResponseException(): bool;
+
+    /**
+     * Send the HTTP request using the Elastic Transport.
+     * It manages syncronous and asyncronus requests using Client::getAsync()
+     * 
+     * @return Elasticsearch|Promise
+     */
+    public function sendRequest(RequestInterface $request);
+}

src/Endpoints/AbstractEndpoint.php

@@ -14,16 +14,16 @@
 
 namespace Elastic\Elasticsearch\Endpoints;
 
-use Elastic\Elasticsearch\Client;
+use Elastic\Elasticsearch\ClientInterface;
 use Elastic\Elasticsearch\Traits\EndpointTrait;
 
 abstract class AbstractEndpoint
 {
     use EndpointTrait;
 
-    protected Client $client;
+    protected ClientInterface $client;
 
-    public function __construct(Client $client)
+    public function __construct(ClientInterface $client)
     {
         $this->client = $client;
     }