PHPstan level 6

Author: curry684

composer.json

@@ -30,6 +30,7 @@
     "require-dev": {
         "ext-curl": "*",
         "ext-json": "*",
+        "ext-mongodb": "*",
         "ext-pdo_sqlite": "*",
         "ext-zip": "*",
         "doctrine/common": "^2.6|^3.3",

phpstan.neon

@@ -1,8 +1,13 @@
 parameters:
-    level: 5
+    level: 6
     paths:
-    - src
+        - src
     excludePaths:
-    - tests/Fixtures
+        # We're not really testing these 2 barely supported adapters
+        - src/Adapter/Elasticsearch
+        - src/Adapter/MongoDB
 
-    checkGenericClassInNonGenericObjectType: false
+        # Fixture is messy
+        - tests/Fixtures
+
+    checkGenericClassInNonGenericObjectType: false

src/Adapter/AbstractAdapter.php

@@ -78,5 +78,8 @@ abstract protected function prepareQuery(AdapterQuery $query): void;
 
     abstract protected function mapPropertyPath(AdapterQuery $query, AbstractColumn $column): ?string;
 
+    /**
+     * @return \Traversable<mixed[]>
+     */
     abstract protected function getResults(AdapterQuery $query): \Traversable;
 }

src/Adapter/AdapterQuery.php

@@ -22,100 +22,69 @@
  */
 class AdapterQuery
 {
-    /** @var DataTableState */
-    private $state;
-
-    /** @var int|null */
-    private $totalRows;
-
-    /** @var int|null */
-    private $filteredRows;
-
-    /** @var string|null */
-    private $identifierPropertyPath;
+    private ?int $totalRows;
+    private ?int $filteredRows;
+    private ?string $identifierPropertyPath = null;
 
     /** @var array<string, mixed> */
-    private $data;
+    private array $data;
 
-    /**
-     * AdapterQuery constructor.
-     */
-    public function __construct(DataTableState $state)
+    public function __construct(private readonly DataTableState $state)
     {
-        $this->state = $state;
     }
 
     public function getState(): DataTableState
     {
         return $this->state;
     }
 
-    /**
-     * @return int|null
-     */
-    public function getTotalRows()
+    public function getTotalRows(): ?int
     {
         return $this->totalRows;
     }
 
-    /**
-     * @param int|null $totalRows
-     * @return $this
-     */
-    public function setTotalRows($totalRows): static
+    public function setTotalRows(?int $totalRows): static
     {
         $this->totalRows = $totalRows;
 
         return $this;
     }
 
-    /**
-     * @return int|null
-     */
-    public function getFilteredRows()
+    public function getFilteredRows(): ?int
     {
         return $this->filteredRows;
     }
 
-    /**
-     * @param int|null $filteredRows
-     * @return $this
-     */
-    public function setFilteredRows($filteredRows): static
+    public function setFilteredRows(?int $filteredRows): static
     {
         $this->filteredRows = $filteredRows;
 
         return $this;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getIdentifierPropertyPath()
+    public function getIdentifierPropertyPath(): ?string
     {
         return $this->identifierPropertyPath;
     }
 
-    /**
-     * @param string|null $identifierPropertyPath
-     * @return $this
-     */
-    public function setIdentifierPropertyPath($identifierPropertyPath): static
+    public function setIdentifierPropertyPath(?string $identifierPropertyPath): static
     {
         $this->identifierPropertyPath = $identifierPropertyPath;
 
         return $this;
     }
 
     /**
-     * @return mixed|null
+     * @template T
+     * @param T $default
+     * @return T|mixed
      */
-    public function get(string $key, $default = null)
+    public function get(string $key, mixed $default = null): mixed
     {
         return $this->data[$key] ?? $default;
     }
 
-    public function set(string $key, $value)
+    public function set(string $key, mixed $value): void
     {
         $this->data[$key] = $value;
     }

src/Adapter/ArrayAdapter.php

@@ -71,9 +71,11 @@ public function getData(DataTableState $state): ResultSetInterface
     }
 
     /**
-     * @return \Generator
+     * @param mixed[][] $data
+     * @param array<string, string> $map
+     * @return \Generator<mixed[]>
      */
-    protected function processData(DataTableState $state, array $data, array $map)
+    protected function processData(DataTableState $state, array $data, array $map): \Generator
     {
         $transformer = $state->getDataTable()->getTransformer();
         $search = $state->getGlobalSearch() ?: '';
@@ -88,9 +90,11 @@ protected function processData(DataTableState $state, array $data, array $map)
     }
 
     /**
-     * @return array|null
+     * @param mixed[] $result
+     * @param array<string, string> $map
+     * @return mixed[]|null
      */
-    protected function processRow(DataTableState $state, array $result, array $map, string $search)
+    protected function processRow(DataTableState $state, array $result, array $map, string $search): ?array
     {
         $row = [];
         $match = empty($search);

src/Adapter/ArrayResultSet.php

@@ -16,20 +16,18 @@
  * ArrayResultSet.
  *
  * @author Niels Keurentjes <[email protected]>
+ *
+ * @phpstan-type Row array<string, mixed>
  */
 class ArrayResultSet implements ResultSetInterface
 {
-    /** @var array */
-    private $data;
-
-    /** @var int */
-    private $totalRows;
-
-    /** @var int */
-    private $totalFilteredRows;
+    /** @var Row[] */
+    private array $data;
+    private int $totalRows;
+    private int $totalFilteredRows;
 
     /**
-     * ArrayResultSet constructor.
+     * @param Row[] $data
      */
     public function __construct(array $data, int $totalRows = null, int $totalFilteredRows = null)
     {

src/Adapter/Doctrine/FetchJoinORMAdapter.php

@@ -26,10 +26,13 @@
  * the Doctrine Paginator.
  *
  * @author Jan Böhmer
+ *
+ * @phpstan-import-type ORMOptions from ORMAdapter
+ * @phpstan-type FetchJoinORMOptions array{simple_total_query: bool}
  */
 class FetchJoinORMAdapter extends ORMAdapter
 {
-    protected $use_simple_total;
+    protected bool $useSimpleTotal;
 
     protected function configureOptions(OptionsResolver $resolver): void
     {
@@ -45,11 +48,14 @@ protected function configureOptions(OptionsResolver $resolver): void
         $resolver->setDefault('simple_total_query', false);
     }
 
+    /**
+     * @param FetchJoinORMOptions|ORMOptions $options
+     */
     protected function afterConfiguration(array $options): void
     {
         parent::afterConfiguration($options);
 
-        $this->use_simple_total = $options['simple_total_query'];
+        $this->useSimpleTotal = $options['simple_total_query'];
     }
 
     protected function prepareQuery(AdapterQuery $query): void
@@ -70,7 +76,7 @@ protected function prepareQuery(AdapterQuery $query): void
         $identifier = "{$fromClause->getAlias()}.{$this->metadata->getSingleIdentifierFieldName()}";
 
         // Use simpler (faster) total count query if the user wanted so...
-        if ($this->use_simple_total) {
+        if ($this->useSimpleTotal) {
             $query->setTotalRows($this->getSimpleTotalCount($builder));
         } else {
             $query->setTotalRows($this->getCount($builder, $identifier));
@@ -117,21 +123,23 @@ public function getResults(AdapterQuery $query): \Traversable
         }
     }
 
-    public function getCount(QueryBuilder $queryBuilder, $identifier): int
+    public function getCount(QueryBuilder $queryBuilder, mixed $identifier): int
     {
         $paginator = new Paginator($queryBuilder);
 
         return $paginator->count();
     }
 
-    protected function getSimpleTotalCount(QueryBuilder $queryBuilder)
+    /**
+     * The paginator count queries can be rather slow, so when query for total count (100ms or longer),
+     * just return the entity count.
+     */
+    protected function getSimpleTotalCount(QueryBuilder $queryBuilder): int
     {
-        /** The paginator count queries can be rather slow, so when query for total count (100ms or longer),
-         * just return the entity count.
-         */
         /** @var Query\Expr\From $from_expr */
         $from_expr = $queryBuilder->getDQLPart('from')[0];
 
+        /* @phpstan-ignore-next-line Unable to determine repository type */
         return $this->manager->getRepository($from_expr->getFrom())->count([]);
     }
 }

src/Adapter/Doctrine/ORM/AutomaticQueryBuilder.php

@@ -25,27 +25,19 @@
  */
 class AutomaticQueryBuilder implements QueryBuilderProcessorInterface
 {
-    /** @var EntityManagerInterface */
-    private $em;
+    private EntityManagerInterface $em;
+    private ClassMetadata $metadata;
+    private string $entityShortName;
 
-    /** @var ClassMetadata */
-    private $metadata;
+    /** @var class-string */
+    private string $entityName;
 
-    /** @var string */
-    private $entityName;
+    /** @var array<string, string[]> */
+    private array $selectColumns = [];
 
-    /** @var string */
-    private $entityShortName;
+    /** @var array<string, string[]> */
+    private array $joins = [];
 
-    /** @var array */
-    private $selectColumns = [];
-
-    /** @var array */
-    private $joins = [];
-
-    /**
-     * AutomaticQueryBuilder constructor.
-     */
     public function __construct(EntityManagerInterface $em, ClassMetadata $metadata)
     {
         $this->em = $em;
@@ -55,7 +47,7 @@ public function __construct(EntityManagerInterface $em, ClassMetadata $metadata)
         $this->entityShortName = mb_strtolower($this->metadata->getReflectionClass()->getShortName());
     }
 
-    public function process(QueryBuilder $builder, DataTableState $state)
+    public function process(QueryBuilder $builder, DataTableState $state): void
     {
         if (empty($this->selectColumns) && empty($this->joins)) {
             foreach ($state->getDataTable()->getColumns() as $column) {
@@ -67,7 +59,7 @@ public function process(QueryBuilder $builder, DataTableState $state)
         $this->setJoins($builder);
     }
 
-    protected function processColumn(AbstractColumn $column)
+    protected function processColumn(AbstractColumn $column): void
     {
         $field = $column->getField();
 
@@ -80,7 +72,7 @@ protected function processColumn(AbstractColumn $column)
         }
     }
 
-    private function addSelectColumns(AbstractColumn $column, string $field)
+    private function addSelectColumns(AbstractColumn $column, string $field): void
     {
         $currentPart = $this->entityShortName;
         $currentAlias = $currentPart;
@@ -111,7 +103,7 @@ private function addSelectColumns(AbstractColumn $column, string $field)
         }
     }
 
-    private function addSelectColumn($columnTableName, $data)
+    private function addSelectColumn(string $columnTableName, string $data): void
     {
         if (isset($this->selectColumns[$columnTableName])) {
             if (!in_array($data, $this->selectColumns[$columnTableName], true)) {
@@ -120,18 +112,16 @@ private function addSelectColumn($columnTableName, $data)
         } else {
             $this->selectColumns[$columnTableName][] = $data;
         }
-
-        return $this;
     }
 
-    private function getIdentifier(ClassMetadata $metadata)
+    private function getIdentifier(ClassMetadata $metadata): string
     {
         $identifiers = $metadata->getIdentifierFieldNames();
 
         return array_shift($identifiers);
     }
 
-    private function setIdentifierFromAssociation(string $association, string $key, ClassMetadata $metadata)
+    private function setIdentifierFromAssociation(string $association, string $key, ClassMetadata $metadata): ClassMetadata
     {
         $targetEntityClass = $metadata->getAssociationTargetClass($key);
 
@@ -142,7 +132,7 @@ private function setIdentifierFromAssociation(string $association, string $key,
         return $targetMetadata;
     }
 
-    private function setSelectFrom(QueryBuilder $qb)
+    private function setSelectFrom(QueryBuilder $qb): void
     {
         foreach ($this->selectColumns as $key => $value) {
             if (false === empty($key)) {
@@ -151,16 +141,12 @@ private function setSelectFrom(QueryBuilder $qb)
                 $qb->addSelect($value);
             }
         }
-
-        return $this;
     }
 
-    private function setJoins(QueryBuilder $qb)
+    private function setJoins(QueryBuilder $qb): void
     {
         foreach ($this->joins as $key => $value) {
             $qb->{$value['type']}($key, $value['alias']);
         }
-
-        return $this;
     }
 }