CI - GH Actions: Increase PHPStan version, fix a load of errors.

Author: homersimpsons

.github/workflows/continuous-integration.yml

@@ -137,7 +137,6 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.1"
           - "7.3"
           - "7.4"
 

composer.json

@@ -13,7 +13,7 @@
         }
     ],
     "require": {
-    	"php": ">=7.1.0",
+    	"php": ">=7.2.0",
     	"mouf/utils.common.conditioninterface": "~2.0",
     	"mouf/utils.value.value-interface": "~1.0",
     	"mouf/utils.common.paginable-interface": "~1.0",
@@ -27,7 +27,7 @@
         "phpunit/phpunit": "^7.5.10",
         "satooshi/php-coveralls": "~1.0",
         "doctrine/dbal": "~2.5",
-        "phpstan/phpstan": "^0.11.7"
+        "phpstan/phpstan": "^0.12.82"
     },
     "suggest": {
       "doctrine/dbal": "To support more databases than just MySQL and to use MagicJoin feature",

phpstan.neon

@@ -1,8 +1,13 @@
+includes:
+    - phpstan-baseline.neon
+
 parameters:
     level: 7
     paths:
         - src
     inferPrivatePropertyTypeFromConstructor: true
+    checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false
     ignoreErrors:
         - "#Mouf\\\\MoufManager#"
         - "#Mouf\\\\MoufInstanceDescriptor#"

phpunit.xml.dist

@@ -12,7 +12,7 @@
 >
 
     <php>
-        <var name="db_host" value="localhost" />
+        <var name="db_host" value="127.0.0.1" />
         <var name="db_username" value="root" />
         <var name="db_password" value="" />
         <var name="db_driver" value="pdo_mysql"/>

src/Mouf/Database/MagicQuery.php

@@ -2,6 +2,7 @@
 
 namespace Mouf\Database;
 
+use Doctrine\Common\Cache\Cache;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Platforms\MySqlPlatform;
@@ -34,21 +35,20 @@
 class MagicQuery
 {
     private $connection;
+    /** @var Cache */
     private $cache;
+    /** @var SchemaAnalyzer */
     private $schemaAnalyzer;
-    /**
-     * @var AbstractPlatform
-     */
+    /** @var AbstractPlatform */
     private $platform;
-    /**
-     * @var Environment
-     */
+    /** @var Environment */
     private $twigEnvironment;
+    /** @var bool */
     private $enableTwig = false;
 
     /**
      * @param \Doctrine\DBAL\Connection    $connection
-     * @param \Doctrine\Common\Cache\Cache $cache
+     * @param Cache $cache
      * @param SchemaAnalyzer               $schemaAnalyzer (optional). If not set, it is initialized from the connection.
      */
     public function __construct($connection = null, $cache = null, SchemaAnalyzer $schemaAnalyzer = null)
@@ -205,11 +205,9 @@ public function toSql(NodeInterface $sqlNode, array $parameters = array(), bool
     /**
      * Scans the SQL statement and replaces the "magicjoin" part with the correct joins.
      *
-     * @param NodeInterface $select
-     *
      * @throws MagicQueryMissingConnectionException
      */
-    private function magicJoin(NodeInterface $select)
+    private function magicJoin(NodeInterface $select): void
     {
         // Let's find if this is a MagicJoin query.
         $magicJoinDetector = new DetectMagicJoinSelectVisitor();
@@ -227,12 +225,8 @@ private function magicJoin(NodeInterface $select)
 
     /**
      * For one given MagicJoin select, let's apply MagicJoin.
-     *
-     * @param MagicJoinSelect $magicJoinSelect
-     *
-     * @return Select
      */
-    private function magicJoinOnOneQuery(MagicJoinSelect $magicJoinSelect)
+    private function magicJoinOnOneQuery(MagicJoinSelect $magicJoinSelect): void
     {
         $tableSearchNodeTraverser = new NodeTraverser();
         $detectTableVisitor = new DetectTablesVisitor($magicJoinSelect->getMainTable());
@@ -316,7 +310,7 @@ private function getSchemaAnalyzer()
         return $this->schemaAnalyzer;
     }
 
-    private function getConnectionUniqueId(Connection $connection)
+    private function getConnectionUniqueId(Connection $connection): string
     {
         return hash('md4', $connection->getHost().'-'.$connection->getPort().'-'.$connection->getDatabase().'-'.$connection->getDriver()->getName());
     }

src/Mouf/Database/MagicQuery/Twig/SqlTwigEnvironmentFactory.php

@@ -12,9 +12,10 @@
  */
 class SqlTwigEnvironmentFactory
 {
+    /** @var Environment|null */
     private static $twig;
 
-    public static function getTwigEnvironment()
+    public static function getTwigEnvironment(): Environment
     {
         if (self::$twig) {
             return self::$twig;
@@ -45,7 +46,7 @@ public static function getTwigEnvironment()
         return $twig;
     }
 
-    private static function getCacheDirectory()
+    private static function getCacheDirectory(): string
     {
         // If we are running on a Unix environment, let's prepend the cache with the user id of the PHP process.
         // This way, we can avoid rights conflicts.

src/Mouf/Database/MagicQuery/Twig/StringLoader.php

@@ -20,21 +20,14 @@ class StringLoader implements LoaderInterface
     /**
      * {@inheritdoc}
      */
-    public function getSource($name)
+    public function getCacheKey(string $name): string
     {
         return $name;
     }
     /**
      * {@inheritdoc}
      */
-    public function getCacheKey($name): string
-    {
-        return $name;
-    }
-    /**
-     * {@inheritdoc}
-     */
-    public function isFresh($name, $time): bool
+    public function isFresh(string $name, int $time): bool
     {
         return true;
     }

src/Mouf/Database/QueryWriter/QueryResult.php

@@ -44,8 +44,10 @@ class QueryResult implements ArrayValueInterface, PaginableInterface, SortableIn
      */
     private $parameters = array();
 
-    private $limit;
+    /** @var int|null */
     private $offset;
+    /** @var int|null */
+    private $limit;
 
     /**
      * @param Select     $select
@@ -62,7 +64,7 @@ public function __construct(Select $select, Connection $connection)
      *
      * @param array<string, string>|array<string, ValueInterface>|ArrayValueInterface $parameters
      */
-    public function setParameters($parameters)
+    public function setParameters($parameters): void
     {
         $this->parameters = $parameters;
     }
@@ -98,7 +100,7 @@ public function toSql()
      * @param int $limit
      * @param int $offset
      */
-    public function paginate($limit, $offset = 0)
+    public function paginate($limit, $offset = 0): void
     {
         $this->limit = $limit;
         $this->offset = $offset;
@@ -107,7 +109,7 @@ public function paginate($limit, $offset = 0)
     /* (non-PHPdoc)
      * @see \Mouf\Utils\Common\SortableInterface::sort()
      */
-    public function sort($key, $direction = SortableInterface::ASC)
+    public function sort($key, $direction = SortableInterface::ASC): void
     {
         $result = $this->findColumnByKey($key);
         if ($result != null) {

src/Mouf/Database/QueryWriter/ResultSet.php

@@ -2,7 +2,8 @@
 
 namespace Mouf\Database\QueryWriter;
 
-use Doctrine\DBAL\Statement;
+use Doctrine\DBAL\FetchMode;
+use Doctrine\DBAL\Driver\Statement;
 
 /**
  * Wraps the results of a PDOStatement.
@@ -11,20 +12,20 @@
  */
 class ResultSet implements \Iterator
 {
-    /**
-     * @var \PDOStatement|Statement
-     */
+    /** @var Statement */
     private $statement;
-    private $castToClass;
+    /** @var int */
     private $key = 0;
+    /** @var array|false */
     private $result;
+    /** @var bool */
     private $fetched = false;
+    /** @var int */
     private $rewindCalls = 0;
 
-    public function __construct($statement, $castToClass = '')
+    public function __construct(Statement $statement)
     {
         $this->statement = $statement;
-        $this->castToClass = $castToClass;
     }
 
     public function rewind()
@@ -35,6 +36,9 @@ public function rewind()
         }
     }
 
+    /**
+     * @return array|false
+     */
     public function current()
     {
         if (!$this->fetched) {
@@ -44,6 +48,9 @@ public function current()
         return $this->result;
     }
 
+    /**
+     * @return int
+     */
     public function key()
     {
         return $this->key;
@@ -56,9 +63,9 @@ public function next()
         $this->fetch();
     }
 
-    private function fetch()
+    private function fetch(): void
     {
-        $this->result = $this->statement->fetch(\PDO::FETCH_ASSOC);
+        $this->result = $this->statement->fetch(FetchMode::ASSOCIATIVE);
         $this->fetched = true;
     }
 

src/Mouf/Database/QueryWriter/Utils/DbHelper.php

@@ -2,14 +2,15 @@
 
 namespace Mouf\Database\QueryWriter\Utils;
 
+use Doctrine\DBAL\Connection;
 use Mouf\MoufManager;
 
 class DbHelper
 {
-    public static function getAll($sql, $offset, $limit)
+    public static function getAll(string $sql, ?int $offset, ?int $limit)
     {
+        /** @var Connection $dbalConnection */
         $dbalConnection = MoufManager::getMoufManager()->get('dbalConnection');
-        /* @var $dbalConnection \Doctrine\DBAL\Connection */
         $sql .= self::getFromLimitString($offset, $limit);
         $statement = $dbalConnection->executeQuery($sql);
         $results = $statement->fetchAll();
@@ -23,15 +24,13 @@ public static function getAll($sql, $offset, $limit)
         return $array;
     }
 
-    public static function getFromLimitString($from = null, $limit = null)
+    public static function getFromLimitString(?int $from = null, ?int $limit = null): string
     {
         if ($limit !== null) {
-            $limitInt = (int) $limit;
-            $queryStr = ' LIMIT '.$limitInt;
+            $queryStr = ' LIMIT '.$limit;
 
             if ($from !== null) {
-                $fromInt = (int) $from;
-                $queryStr .= ' OFFSET '.$fromInt;
+                $queryStr .= ' OFFSET '.$from;
             }
 
             return $queryStr;