Upgrade to PHPStan 0.9.1 (#713)

* fix invalid types in phpdoc in src/

* fix invalid types in phpdoc in tests/

* PHPStan 0.9.1

Author: mhujer

composer.json

@@ -19,7 +19,7 @@
     "cpliakas/git-wrapper": "~1.0",
     "doctrine/inflector": "^1.1",
     "mockery/mockery": "0.9.4",
-    "phpstan/phpstan-shim": "0.8.5",
+    "phpstan/phpstan-shim": "0.9.1",
     "phpunit/phpunit": "6.3.0",
     "squizlabs/php_codesniffer": "3.0.2",
     "symfony/finder": "^2.8",

phpstan-src.neon

@@ -1,2 +1,6 @@
 parameters:
     ignoreErrors:
+
+        # nullable types are missing everywhere
+        # this should be removed and fixed in the code later
+        - '#Variable (.*) in isset\(\) always exists and is not nullable.#'

phpstan-tests.neon

@@ -2,11 +2,13 @@ parameters:
     ignoreErrors:
         - '#Mockery\\MockInterface::shouldReceive\(\)#'
         - '#Mockery\\MockInterface given#'
-        - '#Mockery\\MockInterface\[\] given#'
 
         # because of \Elasticsearch\Tests\RegisteredNamespaceTest
         - '#Call to an undefined method Elasticsearch\\Client::foo\(\)#'
         - '#Call to an undefined method Elasticsearch\\Client::bar\(\)#'
 
         # because of \Elasticsearch\Tests\ClientBuilderTest
         - '#expects Psr\\Log\\LoggerInterface, Elasticsearch\\Tests\\ClientBuilder\\DummyLogger given.$#'
+
+        # probably PHPStan issue, because it actually works https://3v4l.org/s3U2B
+        - '#Argument of an invalid type array\|stdClass supplied for foreach, only iterables are supported#'

src/Elasticsearch/Client.php

@@ -111,7 +111,7 @@ public function __construct(Transport $transport, callable $endpoint, array $reg
     }
 
     /**
-     * @param $params
+     * @param string[] $params
      * @return array
      */
     public function info($params = [])
@@ -127,7 +127,7 @@ public function info($params = [])
     }
 
     /**
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return bool
      */
@@ -168,7 +168,7 @@ public function ping($params = [])
      *        ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
      *        ['_source_include'] = (list) A list of fields to extract and return from the _source field
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -202,7 +202,7 @@ public function get($params)
      *        ['refresh']        = (boolean) Refresh the shard containing the document before performing the operation
      *        ['routing']        = (string) Specific routing value
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -238,7 +238,7 @@ public function getSource($params)
      *        ['timeout']      = (time) Explicit operation timeout
      *        ['version_type'] = (enum) Specific version type
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -337,7 +337,7 @@ public function deleteByQuery($params = array())
      *        ['allow_no_indices']   = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
      *        ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -375,7 +375,7 @@ public function count($params = array())
      *        ['version']            = (number) Explicit version number for concurrency control
      *        ['version_type']       = (enum) Specific version type
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      *
@@ -408,7 +408,7 @@ public function countPercolate($params = array())
      *        ['prefer_local'] = (boolean) With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
      *        ['body']         = (array) The document (`doc`) to percolate against registered queries; optionally also a `query` to limit the percolation to specific registered queries
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      *
@@ -442,7 +442,7 @@ public function percolate($params)
      *        ['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
      *        ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      *
@@ -481,7 +481,7 @@ public function mpercolate($params = array())
      *        ['parent']           = (string) Parent id of documents. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".
      *        ['realtime']         = (boolean) Specifies if request is real-time as opposed to near-real-time (default: true).
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -521,7 +521,7 @@ public function termvectors($params = array())
      *        ['parent']           = (string) Parent id of documents. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".
      *        ['realtime']         = (boolean) Specifies if request is real-time as opposed to near-real-time (default: true).
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -554,7 +554,7 @@ public function mtermvectors($params = array())
      *        ['refresh']    = (boolean) Refresh the shard containing the document before performing the operation
      *        ['routing']    = (string) Specific routing value
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array | boolean
      */
@@ -594,7 +594,7 @@ public function exists($params)
      *        ['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
      *        ['_source_include'] = (list) A list of fields to extract and return from the _source field
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -623,7 +623,7 @@ public function mget($params = array())
      *        ['search_type'] = (enum) Search operation type
      *        ['body']        = (array|string) The request definitions (metadata-search request definition pairs), separated by newlines
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -653,7 +653,7 @@ public function msearch($params = array())
      *        ['body']        = (array|string) The request definitions (metadata-search request definition pairs), separated by newlines
      *        ['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -692,7 +692,7 @@ public function msearchTemplate($params = array())
      *        ['version_type'] = (enum) Specific version type
      *        ['body']         = (array) The document
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -726,7 +726,7 @@ public function create($params)
      *        ['fields']      = (list) Default comma-separated list of fields to return in the response for updates
      *        ['body']        = (array) The document
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -766,7 +766,7 @@ public function bulk($params = array())
      *        ['version_type'] = (enum) Specific version type
      *        ['body']         = (array) The document
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -799,7 +799,7 @@ public function index($params)
      *        ['requests_per_second'] = (float) The throttle for this request in sub-requests per second. 0 means set no throttle
      *        ['body']                = (array) The search definition using the Query DSL and the prototype for the index request (Required)
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -825,7 +825,7 @@ public function reindex($params)
      *        ['source']         = (string) The URL-encoded request definition (instead of using request body)
      *        ['body']           = (array) The request definition
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -867,7 +867,7 @@ public function suggest($params = array())
      *        ['_source_include']          = (list) A list of fields to extract and return from the _source field
      *        ['body']                     = (string) The URL-encoded query definition (instead of using the request body)
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -929,7 +929,7 @@ public function explain($params)
      *        ['version']                  = (boolean) Specify whether to return document version as part of a hit
      *        ['body']                     = (array|string) The search definition using the Query DSL
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -962,7 +962,7 @@ public function search($params = array())
      *        ['allow_no_indices']   = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
      *        ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -987,7 +987,7 @@ public function searchShards($params = array())
      * $params['index']                    = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
      *        ['type']                     = (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1015,7 +1015,7 @@ public function searchTemplate($params = array())
      *        ['scroll']    = (duration) Specify how long a consistent view of the index should be maintained for scrolled search
      *        ['body']      = (string) The scroll ID for scrolled search
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1043,7 +1043,7 @@ public function scroll($params = array())
      *        ['scroll']    = (duration) Specify how long a consistent view of the index should be maintained for scrolled search
      *        ['body']      = (string) The scroll ID for scrolled search
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1083,7 +1083,7 @@ public function clearScroll($params = array())
      *        ['version_type']      = (number) Explicit version number for concurrency control
      *        ['body']              = (array) The request definition using either `script` or partial `doc`
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1204,7 +1204,7 @@ public function updateByQuery($params = array())
      * $params['id']   = (string) The script ID (Required)
      *        ['lang'] = (string) The script language (Required)
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1229,7 +1229,7 @@ public function getScript($params)
      * $params['id']   = (string) The script ID (Required)
      *        ['lang'] = (string) The script language (Required)
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1254,7 +1254,7 @@ public function deleteScript($params)
      * $params['id']   = (string) The script ID (Required)
      *        ['lang'] = (string) The script language (Required)
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1279,7 +1279,7 @@ public function putScript($params)
     /**
      * $params['id']   = (string) The search template ID (Required)
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1301,7 +1301,7 @@ public function getTemplate($params)
     /**
      * $params['id']   = (string) The search template ID (Required)
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1328,7 +1328,7 @@ public function deleteTemplate($params)
      *        ['allow_no_indices']   = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
      *        ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1355,7 +1355,7 @@ public function fieldStats($params = array())
      *        ['allow_no_indices']   = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
      *        ['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1379,7 +1379,7 @@ public function fieldCaps($params = array())
     /**
      * $params['id']                 = (string) ID of the template to render
      *
-     * @param $params array Associative array of parameters
+     * @param array $params Associative array of parameters
      *
      * @return array
      */
@@ -1483,8 +1483,8 @@ public function remote()
     /**
      * Catchall for registered namespaces
      *
-     * @param $name
-     * @param $arguments
+     * @param string $name
+     * @param array $arguments
      * @return Object
      * @throws BadMethodCallException if the namespace cannot be found
      */
@@ -1538,7 +1538,7 @@ private function verifyNotNullOrEmpty($name, $var)
     }
 
     /**
-     * @param $endpoint AbstractEndpoint
+     * @param AbstractEndpoint $endpoint
      *
      * @throws \Exception
      * @return array