General: Fix phpstan level 4 and 5 issues

.github/workflows/php-tests.yml

@@ -9,7 +9,7 @@ jobs:
   php-tests:
     uses: lunr-php/actions-templates/.github/workflows/php-composer.yml@master
     with:
-      phpstan-level: 3
+      phpstan-level: 5
       allow-style-failures: false
       allow-phpstan-failures: false
       codestyle-branch: '0.10.2'

src/Lunr/Gravity/DMLQueryBuilderInterface.php

@@ -336,7 +336,7 @@ public function where_null($left, $negate = FALSE): static;
      *
      * @return $this Self reference
      */
-    public function group_by($expr): static;
+    public function group_by(string $expr): static;
 
     /**
      * Define HAVING clause of the SQL statement.

src/Lunr/Gravity/DatabaseDMLQueryBuilder.php

@@ -473,7 +473,7 @@ protected function sql_with($alias, $sql_query, $recursive_query = NULL, $union
             $column_names = ' (' . implode(', ', $column_names) . ')';
         }
 
-        if ($recursive_query != '' && $recursive_query !== NULL)
+        if ($recursive_query != '')
         {
             $this->is_recursive = TRUE;
 
@@ -485,7 +485,7 @@ protected function sql_with($alias, $sql_query, $recursive_query = NULL, $union
 
         if ($this->with != '')
         {
-            if ($recursive_query != '' && $recursive_query !== NULL)
+            if ($recursive_query != '')
             {
                 $this->with = $alias . $column_names . ' AS ( ' . $sql_query . $recursive_query . ' ), ' . $this->with;
             }
@@ -943,13 +943,13 @@ protected function implode_query($components): string
     /**
      * Prepare the list of index hints for a table reference.
      *
-     * @param array $index_hints Array of Index Hints
+     * @param array|null $index_hints Array of Index Hints
      *
      * @return string $hints Comma separated list of index hints.
      */
-    protected function prepare_index_hints($index_hints): string
+    protected function prepare_index_hints(?array $index_hints): string
     {
-        if (is_array($index_hints) && !empty($index_hints))
+        if (!empty($index_hints))
         {
             $index_hints = array_diff($index_hints, [ NULL ]);
             $hints       = ' ' . implode(', ', $index_hints);

src/Lunr/Gravity/MySQL/MySQLDMLQueryBuilder.php

@@ -192,16 +192,16 @@ public function where_regexp($left, $right, $negate = FALSE): static
     /**
      * Define GROUP BY clause of the SQL statement.
      *
-     * @param string $expr  Expression to group by
-     * @param bool   $order Order ASCending/TRUE or DESCending/FALSE, default no order/NULL
+     * @param string    $expr  Expression to group by
+     * @param bool|null $order Order ASCending/TRUE or DESCending/FALSE, default no order/NULL
      *
      * @return $this Self reference
      */
-    public function group_by($expr, $order = NULL): static
+    public function group_by(string $expr, ?bool $order = NULL): static
     {
         $this->sql_group_by($expr);
 
-        if ($order !== NULL && is_bool($order))
+        if ($order !== NULL)
         {
             $direction       = ($order === TRUE) ? ' ASC' : ' DESC';
             $this->group_by .= $direction;

src/Lunr/Gravity/MySQL/MySQLQueryEscaper.php

@@ -143,9 +143,9 @@ public function geovalue($value, $srid = NULL): string
      *
      * @return string|null $return NULL for invalid indices, escaped string otherwise.
      */
-    public function index_hint($keyword, $indices, $for = ''): ?string
+    public function index_hint(string $keyword, array $indices, string $for = ''): ?string
     {
-        if (!is_array($indices) || empty($indices))
+        if (empty($indices))
         {
             return NULL;
         }

src/Lunr/Gravity/MySQL/Tests/MySQLQueryEscaperEscapeTest.php

@@ -263,7 +263,7 @@ public function testEscapingLikeValueUnsupported(): void
      */
     public function testEscapingIndexHintWithInvalidIndices($indices): void
     {
-        $this->assertNull($this->class->index_hint('', '', $indices));
+        $this->assertNull($this->class->index_hint('', $indices));
     }
 
     /**

src/Lunr/Gravity/MySQL/Tests/MySQLQueryEscaperTestCase.php

@@ -12,7 +12,6 @@
 
 use Lunr\Gravity\MySQL\MySQLQueryEscaper;
 use Lunr\Halo\LunrBaseTestCase;
-use stdClass;
 
 /**
  * This class contains the tests for the MySQLQueryEscaper class.
@@ -66,10 +65,6 @@ public function tearDown(): void
     public function invalidIndicesProvider(): array
     {
         $indices   = [];
-        $indices[] = [ NULL ];
-        $indices[] = [ FALSE ];
-        $indices[] = [ 'string' ];
-        $indices[] = [ new stdClass() ];
         $indices[] = [ [] ];
 
         return $indices;

src/Lunr/Gravity/SQLite3/SQLite3DMLQueryBuilder.php

@@ -227,12 +227,12 @@ public function where_regexp($left, $right, $negate = FALSE): static
     /**
      * Define GROUP BY clause of the SQL statement.
      *
-     * @param string $expr  Expression to group by
-     * @param bool   $order Not supported by SQLite
+     * @param string    $expr  Expression to group by
+     * @param bool|null $order Not supported by SQLite
      *
      * @return $this Self reference
      */
-    public function group_by($expr, $order = NULL): static
+    public function group_by(string $expr, ?bool $order = NULL): static
     {
         $this->sql_group_by($expr);
         return $this;

src/Lunr/Gravity/SQLite3/SQLite3QueryEscaper.php

@@ -115,9 +115,9 @@ public function likevalue($value, $match = 'both', $collation = '', $charset = '
      *
      * @return string|null $return NULL for invalid indices, escaped string otherwise.
      */
-    public function index_hint($keyword, $indices, $for = ''): ?string
+    public function index_hint(string $keyword, array $indices, string $for = ''): ?string
     {
-        if (!is_array($indices) || empty($indices))
+        if (empty($indices))
         {
             return NULL;
         }

src/Lunr/Gravity/SQLite3/Tests/SQLite3QueryEscaperEscapeTest.php

@@ -118,7 +118,7 @@ public function testEscapingLikeValueUnsupported(): void
      */
     public function testEscapingIndexHintWithInvalidIndices($indices): void
     {
-        $this->assertNull($this->class->index_hint('', '', $indices));
+        $this->assertNull($this->class->index_hint('', $indices));
     }
 
     /**

src/Lunr/Gravity/SQLite3/Tests/SQLite3QueryEscaperTestCase.php

@@ -12,7 +12,6 @@
 
 use Lunr\Gravity\SQLite3\SQLite3QueryEscaper;
 use Lunr\Halo\LunrBaseTestCase;
-use stdClass;
 
 /**
  * This class contains the tests for the SQLite3QueryEscaper class.
@@ -66,10 +65,6 @@ public function tearDown(): void
     public function invalidIndicesProvider(): array
     {
         $indices   = [];
-        $indices[] = [ NULL ];
-        $indices[] = [ FALSE ];
-        $indices[] = [ 'string' ];
-        $indices[] = [ new stdClass() ];
         $indices[] = [ [] ];
 
         return $indices;

src/Lunr/Gravity/Tests/DatabaseDMLQueryBuilderTestCase.php

@@ -14,7 +14,6 @@
 use Lunr\Halo\LunrBaseTestCase;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\MockObject\Stub;
-use stdClass;
 
 /**
  * This class contains common setup routines, providers
@@ -108,10 +107,6 @@ public function invalidIndexHintProvider(): array
         $hints   = [];
         $hints[] = [ [] ];
         $hints[] = [ NULL ];
-        $hints[] = [ FALSE ];
-        $hints[] = [ 1 ];
-        $hints[] = [ 'string' ];
-        $hints[] = [ new stdClass() ];
 
         return $hints;
     }

tests/phpstan.neon.dist

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: CC0-1.0
 
 parameters:
-    level: 3
+    level: 5
     paths:
         - ../src
     bootstrapFiles: