From 262092b3b2d437ee7f3901ac0c59714d6e0aee86 Mon Sep 17 00:00:00 2001 From: Fran Moreno Date: Fri, 24 Jun 2022 15:25:02 +0200 Subject: [PATCH] Update Query::create parameter types (#2088) --- CHANGELOG.md | 2 ++ src/Index.php | 3 +-- src/Query.php | 2 +- src/Search.php | 12 +++++++----- src/SearchableInterface.php | 15 ++++++++------- 5 files changed, 19 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2068865f1e..1bb8cbd8d5 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * `ExceptionInterface` extends `Throwable` [#2083](https://github.com/ruflin/Elastica/pull/2083) * Changed `value` in `SetProcessor` to accept `mixed` instead of `string` by @franmomu [#2082](https://github.com/ruflin/Elastica/pull/2082) * Sanitize host name for AWS requests before signing in AWSAuthV4 transport +* Updated `Query::create` PHPDoc to include supported types and propagate it to callers by @franmomu [#2088](https://github.com/ruflin/Elastica/pull/2088) + ### Deprecated * Deprecated `Elastica\Reindex::WAIT_FOR_COMPLETION_FALSE`, use a boolean as parameter instead by @franmomu [#2070](https://github.com/ruflin/Elastica/pull/2070) * Passing anything else than a boolean as 1st argument to `Reindex::setWaitForCompletion`, pass a boolean instead by @franmomu [#2070](https://github.com/ruflin/Elastica/pull/2070) diff --git a/src/Index.php b/src/Index.php index fd6cc96420..fad1f2af9e 100644 --- a/src/Index.php +++ b/src/Index.php @@ -455,8 +455,7 @@ public function exists(): bool } /** - * @param AbstractQuery|array|Collapse|Query|string|Suggest $query - * @param array|int $options + * {@inheritdoc} */ public function createSearch($query = '', $options = null, ?BuilderInterface $builder = null): Search { diff --git a/src/Query.php b/src/Query.php index 1c652abedc..7a0013e885 100644 --- a/src/Query.php +++ b/src/Query.php @@ -50,7 +50,7 @@ public function __construct($query = null) * * For example, an empty argument will return a \Elastica\Query with a \Elastica\Query\MatchAll. * - * @param mixed $query + * @param AbstractQuery|AbstractSuggest|array|Collapse|Query|string|Suggest|null $query * * @throws InvalidException For an invalid argument */ diff --git a/src/Search.php b/src/Search.php index 7fbee07f47..9fd666be95 100644 --- a/src/Search.php +++ b/src/Search.php @@ -4,8 +4,10 @@ use Elastica\Exception\InvalidException; use Elastica\Exception\ResponseException; +use Elastica\Query\AbstractQuery; use Elastica\ResultSet\BuilderInterface; use Elastica\ResultSet\DefaultBuilder; +use Elastica\Suggest\AbstractSuggest; /** * Elastica search object. @@ -112,7 +114,7 @@ public function addIndices(array $indices = []): self } /** - * @param array|Query|Query\AbstractQuery|string|Suggest $query + * @param AbstractQuery|AbstractSuggest|array|Collapse|Query|string|Suggest $query */ public function setQuery($query): self { @@ -254,8 +256,8 @@ public function getPath(): string /** * Search in the set indices. * - * @param array|Query|Query\AbstractQuery|string $query - * @param array|int $options Limit or associative array of options (option=>value) + * @param AbstractQuery|AbstractSuggest|array|Collapse|Query|string|Suggest $query + * @param array|int $options Limit or associative array of options (option=>value) * * @throws InvalidException * @throws ResponseException @@ -311,8 +313,8 @@ public function count($query = '', bool $fullResult = false, string $method = Re } /** - * @param array|int $options - * @param array|Query|Query\AbstractQuery|string|Suggest $query + * @param array|int $options + * @param AbstractQuery|AbstractSuggest|array|Collapse|Query|string|Suggest $query */ public function setOptionsAndQuery($options = null, $query = ''): self { diff --git a/src/SearchableInterface.php b/src/SearchableInterface.php index e19769450a..5ecaddb4a0 100644 --- a/src/SearchableInterface.php +++ b/src/SearchableInterface.php @@ -3,6 +3,7 @@ namespace Elastica; use Elastica\Query\AbstractQuery; +use Elastica\Suggest\AbstractSuggest; /** * Elastica searchable interface. @@ -27,9 +28,9 @@ interface SearchableInterface * } * } * - * @param AbstractQuery|array|Collapse|Query|string|Suggest $query Array with all query data inside or a Elastica\Query object - * @param array|int $options Limit or associative array of options (option=>value) - * @param string $method Request method, see Request's constants + * @param AbstractQuery|AbstractSuggest|array|Collapse|Query|string|Suggest $query Array with all query data inside or a Elastica\Query object + * @param array|int|null $options Limit or associative array of options (option=>value) + * @param string $method Request method, see Request's constants */ public function search($query = '', $options = null, string $method = Request::POST): ResultSet; @@ -38,16 +39,16 @@ public function search($query = '', $options = null, string $method = Request::P * * If no query is set, matchall query is created * - * @param AbstractQuery|array|Collapse|Query|string|Suggest $query Array with all query data inside or a Elastica\Query object - * @param string $method Request method, see Request's constants + * @param AbstractQuery|AbstractSuggest|array|Collapse|Query|string|Suggest $query Array with all query data inside or a Elastica\Query object + * @param string $method Request method, see Request's constants * * @return int number of documents matching the query */ public function count($query = '', string $method = Request::POST); /** - * @param AbstractQuery|array|Collapse|Query|string|Suggest $query - * @param mixed|null $options + * @param AbstractQuery|AbstractSuggest|array|Collapse|Query|string|Suggest $query + * @param array|int|null $options */ public function createSearch($query = '', $options = null): Search; }