ruflin / Elastica

src/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 = [])
     {

src/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);

src/Aggregation/Filters.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
      *
      * If a name is given, it will be added as a key, otherwise considered as an anonymous filter
      *
+     * @param string $name
      * @return $this
      */
     public function addFilter(AbstractQuery $filter, ?string $name = null): self

src/ClientConfiguration.php

Doc Comments +1 added lines, -1 removed lines

@@ -164,7 +164,7 @@
      * Add value to a key. If original value is not an array, value is wrapped.
      *
      * @param string $key   Key to add
-     * @param mixed  $value Value
+     * @param string  $value Value
      */
     public function add(string $key, $value): void
     {

src/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)

src/Index.php

Doc Comments +1 added lines, -1 removed lines

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

src/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
      *

src/Node/Info.php

Doc Comments +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
      * Create new info object for node.
      *
      * @param BaseNode $node   Node object
-     * @param array    $params List of params to return. Can be: settings, os, process, jvm, thread_pool, network, transport, http
+     * @param string[]    $params List of params to return. Can be: settings, os, process, jvm, thread_pool, network, transport, http
      */
     public function __construct(BaseNode $node, array $params = [])
     {
@@ -69,7 +69,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()
     {

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 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
      */