ruflin / Elastica

src/Document.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
     /**
      * Get the value of the given field.
      *
-     * @param mixed $key
+     * @param string $key
      *
      * @throws InvalidException If the given field does not exist
      *

src/Index.php

Doc Comments +1 added lines, -1 removed lines

@@ -154,7 +154,7 @@
     /**
      * Update entries in the db based on a query.
      *
-     * @param array|Query|string $query   Query object or array
+     * @param string $query   Query object or array
      * @param AbstractScript     $script  Script
      * @param array              $options Optional params
      *

src/Query.php

Doc Comments +3 added lines, -3 removed lines

@@ -212,7 +212,7 @@ 
      * NOTICE php will encode modified(or named keys) array into object format in json format request
      * so the fields array must a sequence(list) type of array.
      *
-     * @param array $fields Fields to be returned
+     * @param string[] $fields Fields to be returned
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-stored-fields
      */
@@ -349,7 +349,7 @@ 
     /**
      * Sets the _source field to be returned with every hit.
      *
-     * @param array|bool $params Fields to be returned or false to disable source
+     * @param boolean $params Fields to be returned or false to disable source
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-source-filtering
      */
@@ -361,7 +361,7 @@ 
     /**
      * Sets a post_filter to the current query.
      *
-     * @param AbstractQuery|array $filter
+     * @param AbstractQuery $filter
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-post-filter
      */

tests/Aggregation/TopHitsTest.php

Doc Comments +3 added lines

@@ -399,6 +399,9 @@
         return $index;
     }
 
+    /**
+     * @param TopHits $innerAggr
+     */
     protected function getOuterAggregationResult($innerAggr)
     {
         $outerAggr = new Terms('top_tags');

tests/Base.php

Doc Comments +7 added lines

@@ -47,6 +47,7 @@ 
 
     /**
      * @param array $params Additional configuration params. Host and Port are already set
+     * @param \Closure $callback
      */
     protected function _getClient(array $params = [], ?callable $callback = null, ?LoggerInterface $logger = null): Client
     {
@@ -90,6 +91,9 @@ 
         return 'http://'.$proxyHost.':8001';
     }
 
+    /**
+     * @param string $name
+     */
     protected function _createIndex(?string $name = null, bool $delete = true, int $shards = 1): Index
     {
         $name = $name ?: static::buildUniqueId();
@@ -143,6 +147,9 @@ 
         return \substr($data['version']['number'], 0, 1);
     }
 
+    /**
+     * @param string $version
+     */
     protected function _checkVersion($version): void
     {
         $data = $this->_getClient()->request('/')->getData();

tests/Query/IdsTest.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use Elastica\Document;
 use Elastica\Index;
 use Elastica\Query\Ids;
-use Elastica\Query\Type;
 use Elastica\Test\Base as BaseTest;
 
 /**

tests/Transport/GuzzleTest.php

Doc Comments +3 added lines

@@ -139,6 +139,9 @@
         $client->request('_status', 'GET');
     }
 
+    /**
+     * @param string $url
+     */
     protected function checkProxy($url): void
     {
         $url = \parse_url($url);

tests/StatusTest.php

Spacing +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
 
         $indicesWithAlias = $status->getIndicesWithAlias($aliasName);
         $this->assertEquals([$indexName], \array_map(
-            function ($index) {
+            function($index) {
                 return $index->getName();
             },
             $indicesWithAlias

tests/ClientFunctionalTest.php

Spacing +2 added lines, -2 removed lines

@@ -172,7 +172,7 @@ 
         $this->assertEquals('AnonCoin', $index->getDocument(1)->get('name'));
         $this->assertEquals('iXcoin', $index->getDocument(2)->get('name'));
 
-        $ixCoin->setIndex(null);  // Make sure the index gets set properly if missing
+        $ixCoin->setIndex(null); // Make sure the index gets set properly if missing
         $index->deleteDocuments([$anonCoin, $ixCoin]);
 
         $this->expectException(NotFoundException::class);
@@ -385,7 +385,7 @@ 
         $count = 0;
 
         // Callback function which verifies that disabled connection objects are returned
-        $callback = function (Connection $connection, \Exception $exception, Client $client) use (&$count): void {
+        $callback = function(Connection $connection, \Exception $exception, Client $client) use (&$count): void {
             $this->assertInstanceOf(Connection::class, $connection);
             $this->assertInstanceOf(ConnectionException::class, $exception);
             $this->assertInstanceOf(Client::class, $client);