ruflin / Elastica

lib/Elastica/Node/Info.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      * node is running on
      * Example 2: get('os', 'mem') returns an array with all mem infos
      *
-     * @return mixed Data array entry or null if not found
+     * @return string Data array entry or null if not found
      */
     public function get()
     {

lib/Elastica/JSON.php

Doc Comments +1 added lines, -2 removed lines

@@ -15,10 +15,10 @@ 
      * @see http://php.net/manual/en/function.json-decode.php
      * @see http://php.net/manual/en/function.json-last-error.php
      *
-     * @param string $args,... JSON string to parse
      *
      * @throws JSONParseException
      *
+     * @param string $args
      * @return array PHP array representation of JSON string
      */
     public static function parse($args/* inherit from json_decode */)
@@ -49,7 +49,6 @@ 
      * @see http://php.net/manual/en/function.json-encode.php
      * @see http://php.net/manual/en/function.json-last-error.php
      *
-     * @param mixed $args,... Target to stringify
      *
      * @throws JSONParseException
      *

lib/Elastica/Bulk/Action.php

Doc Comments +1 added lines, -1 removed lines

@@ -154,7 +154,7 @@
     }
 
     /**
-     * @param string|int $routing
+     * @param string|boolean $routing
      *
      * @return $this
      */

lib/Elastica/Query.php

Doc Comments +1 added lines, -1 removed lines

@@ -373,7 +373,7 @@
     /**
      * Sets a post_filter to the current query.
      *
-     * @param array|AbstractQuery $filter
+     * @param AbstractQuery $filter
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-post-filter
      */

lib/Elastica/AbstractUpdateAction.php

Doc Comments +3 added lines, -3 removed lines

@@ -188,7 +188,7 @@ 
     }
 
     /**
-     * @param array|string $fields
+     * @param string $fields
      *
      * @return $this
      */
@@ -385,9 +385,9 @@ 
     }
 
     /**
-     * @param array $fields if empty array all options will be returned
+     * @param string[] $fields if empty array all options will be returned
      *
-     * @return array
+     * @return string[]
      */
     public function getOptions(array $fields = [])
     {

lib/Elastica/Document.php

Doc Comments +1 added lines

@@ -78,6 +78,7 @@
      *
      * @throws InvalidException If the given field does not exist
      *
+     * @param string $key
      * @return mixed
      */
     public function get($key)

lib/Elastica/Aggregation/Filter.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
  */
 class Filter extends AbstractAggregation
 {
+    /**
+     * @param AbstractQuery $filter
+     */
     public function __construct(string $name, ?AbstractQuery $filter = null)
     {
         parent::__construct($name);

lib/Elastica/Client.php

Doc Comments +5 added lines, -5 removed lines

@@ -186,7 +186,7 @@ 
      * Sets / overwrites a specific config value.
      *
      * @param string $key   Key to set
-     * @param mixed  $value Value
+     * @param string  $value Value
      *
      * @return $this
      */
@@ -196,8 +196,8 @@ 
     }
 
     /**
-     * @param array|string $keys    config key or path of config keys
-     * @param mixed        $default default value will be returned if key was not found
+     * @param string[] $keys    config key or path of config keys
+     * @param boolean        $default default value will be returned if key was not found
      *
      * @return mixed
      */
@@ -285,7 +285,7 @@ 
      *
      * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
      *
-     * @param array|\Elastica\Document[] $docs Array of Elastica\Document
+     * @param Document[] $docs Array of Elastica\Document
      *
      * @throws \Elastica\Exception\InvalidException If docs is empty
      */
@@ -407,7 +407,7 @@ 
     /**
      * Bulk deletes documents.
      *
-     * @param array|\Elastica\Document[] $docs
+     * @param Document[] $docs
      *
      * @throws \Elastica\Exception\InvalidException
      */

lib/Elastica/Search.php

Doc Comments +3 added lines, -2 removed lines

@@ -70,6 +70,7 @@ 
 
     /**
      * Constructs search object.
+     * @param BuilderInterface $builder
      */
     public function __construct(Client $client, ?BuilderInterface $builder = null)
     {
@@ -282,7 +283,7 @@ 
     /**
      * Search in the set indices.
      *
-     * @param string|array|Query $query
+     * @param string $query
      * @param int|array          $options Limit or associative array of options (option=>value)
      *
      * @throws InvalidException
@@ -310,7 +311,7 @@ 
     }
 
     /**
-     * @param string|array|Query $query
+     * @param string $query
      * @param bool               $fullResult By default only the total hit count is returned. If set to true, the full ResultSet including aggregations is returned
      *
      * @return int|ResultSet