Fix PHPStan issues

Author: sandrokeil

.travis.yml

@@ -14,15 +14,17 @@ matrix:
   - php: 7.2
     env:
     - DEPENDENCIES=""
-    - TEST_COVERAGE=true
+    - EXECUTE_CS_CHECK=true
     - ARANGODB_VERSION=3.4.10
   - php: 7.3
     env:
     - DEPENDENCIES=""
+    - EXECUTE_PHPSTAN=true
     - ARANGODB_VERSION=3.5.5
   - php: 7.4
     env:
     - DEPENDENCIES=""
+    - TEST_COVERAGE=true
     - ARANGODB_VERSION=3.6.4
   - php: nightly
     env:
@@ -49,7 +51,7 @@ before_script:
   - ./test/.travis/setup_arangodb.sh
 
 script:
-  - if [[ $PHPSTAN_CHECK == 'true' ]]; then ./vendor/bin/phpstan analyze -l max -c ./phpstan.installer.neon ./src; fi
+  - if [[ $EXECUTE_PHPSTAN == 'true' ]]; then ./vendor/bin/phpstan analyze -l max -c ./phpstan.installer.neon ./src; fi
   - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/phpcs; fi
   - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/docheader check src/ tests/; fi
   - if [[ $TEST_COVERAGE == 'true' ]]; then php -dzend_extension=xdebug.so ./vendor/bin/phpunit --coverage-text --coverage-clover ./build/logs/clover.xml; fi

phpcs.xml.dist

@@ -23,4 +23,5 @@
 
     <!-- Paths to check -->
     <file>src</file>
+    <file>example</file>
 </ruleset>

phpstan.installer.neon

@@ -6,5 +6,6 @@ parameters:
 		- php
 		- dist
 	reportUnmatchedIgnoredErrors: true
+	checkMissingIterableValueType: false
 	ignoreErrors:
-		- '#and array|string|null results in an error#'
+		- '#Only booleans are allowed in &&, string\|null given on the right side#'

src/Handler/Collection.php

@@ -46,7 +46,7 @@ public function create(string $collectionName, array $options = []): string
 
         $data = Json::decode($response->getBody()->getContents());
 
-        if (!isset($data['id'])) {
+        if (! isset($data['id'])) {
             throw UnexpectedResponse::forType($type, $response);
         }
 
@@ -84,7 +84,7 @@ public function count(string $collectionName): int
 
         $data = Json::decode($response->getBody()->getContents());
 
-        if (!isset($data['count'])) {
+        if (! isset($data['count'])) {
             throw UnexpectedResponse::forType($type, $response);
         }
 

src/Handler/Document.php

@@ -46,7 +46,7 @@ public function save(string $collectionName, array $doc, int $flags = 0): string
 
         $data = Json::decode($response->getBody()->getContents());
 
-        if (!isset($data['_id'])) {
+        if (! isset($data['_id'])) {
             throw UnexpectedResponse::forType($type, $response);
         }
 
@@ -96,5 +96,4 @@ public function hasById(string $collectionName, string $id): bool
     {
         return $this->has($collectionName . self::ID_SEPARATOR . $id);
     }
-
 }

src/Http/BatchResult.php

@@ -14,14 +14,16 @@
 use ArangoDb\Exception\InvalidArgumentException;
 use ArangoDb\Exception\LogicException;
 use ArangoDb\Guard\Guard;
-use ArangoDb\Http\HttpHelper;
 use ArangoDb\Type\BatchType;
 use Countable;
 use Iterator;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamFactoryInterface;
 
+/**
+ * @implements Iterator<string, ResponseInterface>
+ */
 final class BatchResult implements Countable, Iterator
 {
     /**
@@ -128,17 +130,14 @@ public function next(): void
         next($this->responses);
     }
 
-    /**
-     * @return int|string|null
-     */
     public function key()
     {
-        return key($this->responses);
+        return key($this->responses); // @phpstan-ignore-line
     }
 
     public function valid(): bool
     {
-        return $this->key() !== null;
+        return $this->key() !== null; // @phpstan-ignore-line
     }
 
     public function rewind(): void

src/Http/Client.php

@@ -300,7 +300,7 @@ private function updateCommonHttpHeaders(): void
      */
     private function open(RequestInterface $request): void
     {
-        if ($this->useKeepAlive && $this->handle !== null && is_resource($this->handle)) {
+        if ($this->useKeepAlive && $this->handle !== null && is_resource($this->handle)) { // @phpstan-ignore-line
             if (! feof($this->handle)) {
                 return;
             }

src/Http/ClientOptions.php

@@ -10,11 +10,14 @@
 namespace ArangoDb\Http;
 
 use ArangoDb\Exception\LogicException;
+use ArrayAccess;
 
 /**
  * Immutable client options array container
+ *
+ * @implements ArrayAccess<string, mixed>
  */
-final class ClientOptions implements \ArrayAccess
+final class ClientOptions implements ArrayAccess
 {
     // connection options
     public const OPTION_ENDPOINT = 'endpoint';

src/Http/TransactionalClient.php

@@ -112,7 +112,7 @@ public function send(array $params = [], bool $waitForSync = false): ResponseInt
         );
 
         if (0 !== count($guards)) {
-            \array_walk($guards, static function ($guard) use ($response) {
+            \array_walk($guards, static function ($guard) use ($response): void {
                 $guard($response);
             });
         }

src/Statement/Statement.php

@@ -11,9 +11,6 @@
 
 use ArangoDb\Exception\ServerException;
 use ArangoDb\Http\Url;
-use ArangoDb\Statement\QueryResult;
-use ArangoDb\Statement\StreamHandler;
-use ArangoDb\Statement\StreamHandlerFactoryInterface;
 use Countable;
 use Fig\Http\Message\RequestMethodInterface;
 use Fig\Http\Message\StatusCodeInterface;
@@ -23,6 +20,9 @@
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\RequestInterface;
 
+/**
+ * @implements Iterator<int, mixed>
+ */
 final class Statement implements QueryResult, Iterator, Countable
 {
     /**