vendor/elasticsearch/elasticsearch/src/Client.php line 149

Open in your IDE?
  1. <?php
  2. /**
  3.  * Elasticsearch PHP Client
  4.  *
  5.  * @link      https://github.com/elastic/elasticsearch-php
  6.  * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
  7.  * @license   https://opensource.org/licenses/MIT MIT License
  8.  *
  9.  * Licensed to Elasticsearch B.V under one or more agreements.
  10.  * Elasticsearch B.V licenses this file to you under the MIT License.
  11.  * See the LICENSE file in the project root for more information.
  12.  */
  13. declare(strict_types = 1);
  15. namespace Elastic\Elasticsearch;
  17. use Elastic\Elasticsearch\Response\Elasticsearch;
  18. use Elastic\Elasticsearch\Traits\ClientEndpointsTrait;
  19. use Elastic\Elasticsearch\Traits\EndpointTrait;
  20. use Elastic\Elasticsearch\Traits\NamespaceTrait;
  21. use Elastic\Elasticsearch\Transport\AsyncOnSuccess;
  22. use Elastic\Elasticsearch\Transport\AsyncOnSuccessNoException;
  23. use Elastic\Transport\Transport;
  24. use Http\Promise\Promise;
  25. use Psr\Http\Message\RequestInterface;
  26. use Psr\Log\LoggerInterface;
  28. final class Client implements ClientInterface
  29. {
  30.     const CLIENT_NAME = 'es';
  31.     const VERSION = '8.7.1';
  32.     const API_COMPATIBILITY_HEADER = '%s/vnd.elasticsearch+%s; compatible-with=8';
  33.     
  34.     use ClientEndpointsTrait;
  35.     use EndpointTrait;
  36.     use NamespaceTrait;
  37.     
  38.     protected Transport $transport;
  39.     protected LoggerInterface $logger;
  41.     /**
  42.      * Specify is the request is asyncronous
  43.      */
  44.     protected bool $async = false;
  45.     
  46.     /**
  47.      * Enable or disable the x-elastic-meta-header
  48.      */
  49.     protected bool $elasticMetaHeader = true;
  51.     /**
  52.      * Enable or disable the response Exception
  53.      */
  54.     protected bool $responseException = true;
  56.     /**
  57.      * The endpoint namespace storage 
  58.      */
  59.     protected array $namespace;
  61.     public function __construct(
  62.         Transport $transport, 
  63.         LoggerInterface $logger
  64.     ) {
  65.         $this->transport = $transport;
  66.         $this->logger = $logger;       
  67.         
  68.         $this->defaultTransportSettings($this->transport);
  69.     }
  71.     /**
  72.      * @inheritdoc
  73.      */
  74.     public function getTransport(): Transport
  75.     {
  76.         return $this->transport;
  77.     }
  79.     /**
  80.      * @inheritdoc
  81.      */
  82.     public function getLogger(): LoggerInterface
  83.     {
  84.         return $this->logger;
  85.     }
  87.     /**
  88.      * Set the default settings for Elasticsearch
  89.      */
  90.     protected function defaultTransportSettings(Transport $transport): void
  91.     {
  92.         $transport->setUserAgent('elasticsearch-php', self::VERSION);
  93.     }
  95.     /**
  96.      * @inheritdoc
  97.      */
  98.     public function setAsync(bool $async): self
  99.     {
  100.         $this->async = $async;
  101.         return $this;
  102.     }
  104.     /**
  105.      * @inheritdoc
  106.      */
  107.     public function getAsync(): bool
  108.     {
  109.         return $this->async;
  110.     }
  112.     /**
  113.      * @inheritdoc
  114.      */
  115.     public function setElasticMetaHeader(bool $active): self
  116.     {
  117.         $this->elasticMetaHeader = $active;
  118.         return $this;
  119.     }
  121.     /**
  122.      * @inheritdoc
  123.      */
  124.     public function getElasticMetaHeader(): bool
  125.     {
  126.         return $this->elasticMetaHeader;
  127.     }
  129.     /**
  130.      * @inheritdoc
  131.      */
  132.     public function setResponseException(bool $active): self
  133.     {
  134.         $this->responseException = $active;
  135.         return $this;
  136.     }
  138.     /**
  139.      * @inheritdoc
  140.      */
  141.     public function getResponseException(): bool
  142.     {
  143.         return $this->responseException;
  144.     }
  146.     /**
  147.      * @inheritdoc
  148.      */
  149.     public function sendRequest(RequestInterface $request)
  150.     {   
  151.         // If async returns a Promise
  152.         if ($this->getAsync()) {
  153.             if ($this->getElasticMetaHeader()) {
  154.                 $this->transport->setElasticMetaHeader(Client::CLIENT_NAME, Client::VERSION, true);
  155.             }
  156.             $this->transport->setAsyncOnSuccess(
  157.                 $request->getMethod() === 'HEAD'
  158.                     ? new AsyncOnSuccessNoException
  159.                     : ($this->getResponseException() ? new AsyncOnSuccess : new AsyncOnSuccessNoException)
  160.             );
  161.             return $this->transport->sendAsyncRequest($request);
  162.         }     
  164.         if ($this->getElasticMetaHeader()) {
  165.             $this->transport->setElasticMetaHeader(Client::CLIENT_NAME, Client::VERSION, false);
  166.         }
  167.         $start = microtime(true);
  168.         $response = $this->transport->sendRequest($request);
  169.         $this->logger->info(sprintf("Response time in %.3f sec", microtime(true) - $start));       
  171.         $result = new Elasticsearch;
  172.         $result->setResponse($response, $request->getMethod() === 'HEAD' ? false : $this->getResponseException());
  173.         return $result;
  174.     }
  175. }