Add missing @throws annotation to Client::request and related methods (…

…#2152)
ruflin · Mar 24, 2023 · 87a8bf5 · 87a8bf5
1 parent 8c45c15
commit 87a8bf5
Show file tree

Hide file tree

Showing 18 changed files with 342 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -68,6 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 * Added support for PHP 8.2 [#2136](https://github.com/ruflin/Elastica/pull/2136)
+* Added missing `@throws` annotations to Client::request and related methods [#2152](https://github.com/ruflin/Elastica/pull/2152)
 ### Changed
 * Updated `php-cs-fixer` to `3.13.2` [#2143](https://github.com/ruflin/Elastica/pull/2143)
 * Modernize code using `match` expression [#2141](https://github.com/ruflin/Elastica/pull/2141)

diff --git a/src/Bulk.php b/src/Bulk.php
@@ -6,10 +6,12 @@
 use Elastica\Bulk\Action\AbstractDocument as AbstractDocumentAction;
 use Elastica\Bulk\Response as BulkResponse;
 use Elastica\Bulk\ResponseSet;
-use Elastica\Exception\Bulk\ResponseException;
 use Elastica\Exception\Bulk\ResponseException as BulkResponseException;
+use Elastica\Exception\ClientException;
+use Elastica\Exception\ConnectionException;
 use Elastica\Exception\InvalidException;
 use Elastica\Exception\RequestEntityTooLargeException;
+use Elastica\Exception\ResponseException;
 use Elastica\Script\AbstractScript;
 
 class Bulk
@@ -274,6 +276,13 @@ public function toArray(): array
         return $data;
     }
 
+    /**
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
+     * @throws BulkResponseException
+     * @throws InvalidException
+     */
     public function send(): ResponseSet
     {
         $response = $this->_client->request($this->getPath(), Request::POST, (string) $this, $this->_requestParams, Request::NDJSON_CONTENT_TYPE);
@@ -282,7 +291,7 @@ public function send(): ResponseSet
     }
 
     /**
-     * @throws ResponseException
+     * @throws BulkResponseException
      * @throws InvalidException
      */
     protected function _processResponse(Response $response): ResponseSet

diff --git a/src/Client.php b/src/Client.php
@@ -4,6 +4,7 @@
 
 use Elastica\Bulk\Action;
 use Elastica\Bulk\ResponseSet;
+use Elastica\Exception\Bulk\ResponseException as BulkResponseException;
 use Elastica\Exception\ClientException;
 use Elastica\Exception\ConnectionException;
 use Elastica\Exception\InvalidException;
@@ -86,6 +87,10 @@ public function __construct($config = [], ?callable $callback = null, ?LoggerInt
 
     /**
      * Get current version.
+     *
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
      */
     public function getVersion(): string
     {
@@ -203,7 +208,11 @@ public function removeHeader(string $header): self
      *
      * @param array|Document[] $docs Array of Elastica\Document
      *
-     * @throws InvalidException If docs is empty
+     * @throws InvalidException      If docs is empty
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
+     * @throws BulkResponseException
      */
     public function updateDocuments(array $docs, array $requestParams = []): ResponseSet
     {
@@ -232,7 +241,11 @@ public function updateDocuments(array $docs, array $requestParams = []): Respons
      *
      * @param array|Document[] $docs Array of Elastica\Document
      *
-     * @throws InvalidException If docs is empty
+     * @throws InvalidException      If docs is empty
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
+     * @throws BulkResponseException
      */
     public function addDocuments(array $docs, array $requestParams = []): ResponseSet
     {
@@ -260,6 +273,10 @@ public function addDocuments(array $docs, array $requestParams = []): ResponseSe
      * @param array                         $options array of query params to use for query. For possible options check es api
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
+     *
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
      */
     public function updateDocument($id, $data, $index, array $options = []): Response
     {
@@ -321,6 +338,10 @@ public function updateDocument($id, $data, $index, array $options = []): Respons
      * @param array|Document[] $docs
      *
      * @throws InvalidException
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
+     * @throws BulkResponseException
      */
     public function deleteDocuments(array $docs, array $requestParams = []): ResponseSet
     {
@@ -434,6 +455,10 @@ public function setConnections(array $connections)
      * @param bool|string  $routing Optional routing key for all ids
      *
      * @throws InvalidException
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
+     * @throws BulkResponseException
      */
     public function deleteIds(array $ids, $index, $routing = false): ResponseSet
     {
@@ -478,6 +503,9 @@ public function deleteIds(array $ids, $index, $routing = false): ResponseSet
      *
      * @throws ResponseException
      * @throws InvalidException
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws BulkResponseException
      */
     public function bulk(array $params): ResponseSet
     {
@@ -542,6 +570,10 @@ public function request(string $path, string $method = Request::GET, $data = [],
 
     /**
      * Makes calls to the elasticsearch server with usage official client Endpoint.
+     *
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
      */
     public function requestEndpoint(AbstractEndpoint $endpoint): Response
     {
@@ -559,6 +591,10 @@ public function requestEndpoint(AbstractEndpoint $endpoint): Response
      * @param array $args OPTIONAL Optional arguments
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html
+     *
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
      */
     public function forcemergeAll($args = []): Response
     {
@@ -572,6 +608,10 @@ public function forcemergeAll($args = []): Response
      * Closes the given PointInTime.
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html#close-point-in-time-api
+     *
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
      */
     public function closePointInTime(string $pointInTimeId): Response
     {
@@ -585,6 +625,10 @@ public function closePointInTime(string $pointInTimeId): Response
      * Refreshes all search indices.
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
+     *
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
      */
     public function refreshAll(): Response
     {

diff --git a/src/Cluster.php b/src/Cluster.php
@@ -4,6 +4,9 @@
 
 use Elastica\Cluster\Health;
 use Elastica\Cluster\Settings;
+use Elastica\Exception\ClientException;
+use Elastica\Exception\ConnectionException;
+use Elastica\Exception\ResponseException;
 use Elasticsearch\Endpoints\Cluster\State;
 
 /**
@@ -47,6 +50,10 @@ public function __construct(Client $client)
 
     /**
      * Refreshes all cluster information (state).
+     *
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
      */
     public function refresh(): void
     {

diff --git a/src/Cluster/Health.php b/src/Cluster/Health.php
@@ -4,6 +4,9 @@
 
 use Elastica\Client;
 use Elastica\Cluster\Health\Index;
+use Elastica\Exception\ClientException;
+use Elastica\Exception\ConnectionException;
+use Elastica\Exception\ResponseException;
 
 /**
  * Elastic cluster health.
@@ -175,6 +178,10 @@ public function getIndices(): array
 
     /**
      * Retrieves the health data from the cluster.
+     *
+     * @throws ClientException
+     * @throws ConnectionException
+     * @throws ResponseException
      */
     protected function _retrieveHealthData(): array
     {