Skip to content

Commit 3a3f427

Browse files
author
xmarchegay
committed
#11 Push to phpstan level 8 (almost)
1 parent 7fb7c40 commit 3a3f427

7 files changed

+74
-27
lines changed

‎phpstan.neon

+1-14
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,5 @@
11
parameters:
2-
level: 6
2+
level: 8
33
paths:
44
- src
55
- tests
6-
ignoreErrors:
7-
- '#type has no value type specified in iterable type#'
8-
- '#has parameter .* with no value type specified in iterable type#'
9-
- '#has no value type specified in iterable type array#'
10-
- '#configureOptions\(\) has no return type specified.#'
11-
- '#configure\(\) has no return type specified#'
12-
- '#process\(\) has no return type specified#'
13-
- '#should return Iterator but returns Traversable#'
14-
- '#Negated boolean expression is always false#'
15-
checkGenericClassInNonGenericObjectType: false
16-
reportUnmatchedIgnoredErrors: false
17-
inferPrivatePropertyTypeFromConstructor: true
18-
treatPhpDocTypesAsCertain: false

‎src/Task/Database/DatabaseReaderTask.php

+24-4
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,26 @@
1919
use CleverAge\ProcessBundle\Model\ProcessState;
2020
use Doctrine\DBAL\Connection;
2121
use Doctrine\DBAL\Result;
22+
use Doctrine\DBAL\Types\Type;
2223
use Doctrine\Persistence\ManagerRegistry;
2324
use Psr\Log\LoggerInterface;
2425
use Psr\Log\LogLevel;
2526
use Symfony\Component\OptionsResolver\OptionsResolver;
2627

2728
/**
2829
* Fetch entities from doctrine.
30+
*
31+
* @phpstan-type Options array{
32+
* 'sql': ?string,
33+
* 'table': string,
34+
* 'limit': ?int,
35+
* 'empty_log_level': string,
36+
* 'paginate': ?int,
37+
* 'offset': ?int,
38+
* 'input_as_params': bool,
39+
* 'params': array<int<0, max>|string, mixed>,
40+
* 'types': array<int, int|string|Type|null>|array<string, int|string|Type|null>
41+
* }
2942
*/
3043
class DatabaseReaderTask extends AbstractConfigurableTask implements IterableTaskInterface, FinalizableTaskInterface
3144
{
@@ -42,7 +55,7 @@ public function __construct(
4255
/**
4356
* Moves the internal pointer to the next element,
4457
* return true if the task has a next element
45-
* return false if the task has terminated it's iteration.
58+
* return false if the task has terminated its iteration.
4659
*/
4760
public function next(ProcessState $state): bool
4861
{
@@ -57,6 +70,7 @@ public function next(ProcessState $state): bool
5770

5871
public function execute(ProcessState $state): void
5972
{
73+
/** @var Options $options */
6074
$options = $this->getOptions($state);
6175
if (!$this->statement instanceof Result) {
6276
$this->statement = $this->initializeStatement($state);
@@ -102,6 +116,7 @@ public function finalize(ProcessState $state): void
102116

103117
protected function initializeStatement(ProcessState $state): Result
104118
{
119+
/** @var Options $options */
105120
$options = $this->getOptions($state);
106121
$connection = $this->getConnection($state);
107122
$sql = $options['sql'];
@@ -121,7 +136,10 @@ protected function initializeStatement(ProcessState $state): Result
121136

122137
$sql = $qb->getSQL();
123138
}
124-
$params = $options['input_as_params'] ? $state->getInput() : $options['params'];
139+
140+
/** @var array<string> $inputAsParams */
141+
$inputAsParams = $state->getInput();
142+
$params = $options['input_as_params'] ? $inputAsParams : $options['params'];
125143

126144
return $connection->executeQuery($sql, $params, $options['types']);
127145
}
@@ -168,7 +186,9 @@ protected function configureOptions(OptionsResolver $resolver): void
168186

169187
protected function getConnection(ProcessState $state): Connection
170188
{
171-
/* @noinspection PhpIncompatibleReturnTypeInspection */
172-
return $this->doctrine->getConnection($this->getOption($state, 'connection'));
189+
/** @var Connection $connection */
190+
$connection = $this->doctrine->getConnection($this->getOption($state, 'connection'));
191+
192+
return $connection;
173193
}
174194
}

‎src/Task/Database/DatabaseUpdaterTask.php

+17-4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
use CleverAge\ProcessBundle\Model\ProcessState;
1818
use Doctrine\DBAL\Connection;
1919
use Doctrine\DBAL\Exception;
20+
use Doctrine\DBAL\Types\Type;
2021
use Doctrine\Persistence\ManagerRegistry;
2122
use Psr\Log\LoggerInterface;
2223
use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -25,6 +26,13 @@
2526
* Execute an update/delete in the database from a SQL statement.
2627
*
2728
* @see https://www.doctrine-project.org/projects/doctrine-dbal/en/2.9/reference/data-retrieval-and-manipulation.html#list-of-parameters-conversion
29+
*
30+
* @phpstan-type Options array{
31+
* 'sql': string,
32+
* 'input_as_params': bool,
33+
* 'params': mixed,
34+
* 'types': array<int, int|string|Type|null>|array<string, int|string|Type|null>
35+
* }
2836
*/
2937
class DatabaseUpdaterTask extends AbstractConfigurableTask
3038
{
@@ -48,15 +56,18 @@ public function execute(ProcessState $state): void
4856
*/
4957
protected function initializeStatement(ProcessState $state): int
5058
{
59+
/** @var Options $options */
5160
$options = $this->getOptions($state);
5261
$connection = $this->getConnection($state);
5362

54-
$params = $options['input_as_params'] ? $state->getInput() : $options['params'];
63+
/** @var array<string> $inputAsParams */
64+
$inputAsParams = $state->getInput();
65+
$params = $options['input_as_params'] ? $inputAsParams : $options['params'];
5566
if (!\is_array($params)) {
5667
throw new \UnexpectedValueException('Expecting an array of params');
5768
}
5869

59-
return $connection->executeStatement($options['sql'], $params, $options['types']);
70+
return (int) $connection->executeStatement($options['sql'], $params, $options['types']);
6071
}
6172

6273
protected function configureOptions(OptionsResolver $resolver): void
@@ -77,7 +88,9 @@ protected function configureOptions(OptionsResolver $resolver): void
7788

7889
protected function getConnection(ProcessState $state): Connection
7990
{
80-
/* @noinspection PhpIncompatibleReturnTypeInspection */
81-
return $this->doctrine->getConnection($this->getOption($state, 'connection'));
91+
/** @var Connection $connection */
92+
$connection = $this->doctrine->getConnection($this->getOption($state, 'connection'));
93+
94+
return $connection;
8295
}
8396
}

‎src/Task/EntityManager/AbstractDoctrineQueryTask.php

+7-1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,13 @@ protected function configureOptions(OptionsResolver $resolver): void
5656
);
5757
}
5858

59+
/**
60+
* @template TEntityClass of object
61+
*
62+
* @param EntityRepository<TEntityClass> $repository
63+
* @param array<string, string|array<string|int>|null> $criteria
64+
* @param array<string, string|null> $orderBy
65+
*/
5966
protected function getQueryBuilder(
6067
EntityRepository $repository,
6168
array $criteria,
@@ -80,7 +87,6 @@ protected function getQueryBuilder(
8087
$qb->setParameter($parameterName, $value);
8188
}
8289
}
83-
/* @noinspection ForeachSourceInspection */
8490
foreach ($orderBy as $field => $order) {
8591
$qb->addOrderBy("e.{$field}", $order);
8692
}

‎src/Task/EntityManager/DoctrineBatchWriterTask.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@
1717
use CleverAge\ProcessBundle\Model\ProcessState;
1818
use Doctrine\Common\Util\ClassUtils;
1919
use Doctrine\ORM\EntityManagerInterface;
20+
use Doctrine\Persistence\ObjectManager;
2021
use Symfony\Component\OptionsResolver\OptionsResolver;
2122

2223
/**
2324
* Persists Doctrine entities.
2425
*/
2526
class DoctrineBatchWriterTask extends AbstractDoctrineTask implements FlushableTaskInterface
2627
{
28+
/** @var array<object> */
2729
protected array $batch = [];
2830

2931
public function flush(ProcessState $state): void
@@ -62,7 +64,6 @@ protected function writeBatch(ProcessState $state): void
6264
// Support for multiple entity managers is overkill but might be necessary
6365
$entityManagers = new \SplObjectStorage();
6466
foreach ($this->batch as $entity) {
65-
/** @var object $entity */
6667
$class = ClassUtils::getClass($entity);
6768
$entityManager = $this->doctrine->getManagerForClass($class);
6869
if (!$entityManager instanceof EntityManagerInterface) {
@@ -73,6 +74,7 @@ protected function writeBatch(ProcessState $state): void
7374
}
7475

7576
foreach ($entityManagers as $entityManager) {
77+
/* @var ObjectManager $entityManager */
7678
$entityManager->flush();
7779
}
7880

‎src/Task/EntityManager/DoctrineReaderTask.php

+21-2
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,19 @@
2222

2323
/**
2424
* Fetch entities from doctrine.
25+
*
26+
* @phpstan-type Options array{
27+
* 'empty_log_level': string,
28+
* 'class_name': class-string,
29+
* 'order_by': array<string, string|null>,
30+
* 'offset': ?int,
31+
* 'limit': ?int,
32+
* 'criteria': array{string, string|array<string|int>|null}
33+
* }
2534
*/
2635
class DoctrineReaderTask extends AbstractDoctrineQueryTask implements IterableTaskInterface
2736
{
37+
/** @var \IteratorIterator<mixed, mixed, \Iterator<mixed, mixed>>|null */
2838
protected ?\IteratorIterator $iterator = null;
2939

3040
public function __construct(
@@ -51,6 +61,7 @@ public function next(ProcessState $state): bool
5161

5262
public function execute(ProcessState $state): void
5363
{
64+
/** @var Options $options */
5465
$options = $this->getOptions($state);
5566
if (!$this->iterator instanceof \IteratorIterator) {
5667
/** @var class-string $class */
@@ -62,10 +73,12 @@ public function execute(ProcessState $state): void
6273
$repository = $entityManager->getRepository($class);
6374
$this->initIterator($repository, $options);
6475
}
65-
$result = $this->iterator->current();
76+
if ($this->iterator instanceof \IteratorIterator) {
77+
$result = $this->iterator->current();
78+
}
6679

6780
// Handle empty results
68-
if (false === $result) {
81+
if (!isset($result) || false === $result) {
6982
$logContext = [
7083
'options' => $options,
7184
];
@@ -79,6 +92,12 @@ public function execute(ProcessState $state): void
7992
$state->setOutput($result);
8093
}
8194

95+
/**
96+
* @template TEntityClass of object
97+
*
98+
* @param EntityRepository<TEntityClass> $repository
99+
* @param Options $options
100+
*/
82101
protected function initIterator(EntityRepository $repository, array $options): void
83102
{
84103
$qb = $this->getQueryBuilder(

‎src/Task/EntityManager/DoctrineWriterTask.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public function execute(ProcessState $state): void
3131
protected function writeEntity(ProcessState $state): mixed
3232
{
3333
$this->getOptions($state);
34-
/** @var object $entity */
34+
/** @var ?object $entity */
3535
$entity = $state->getInput();
3636

3737
if (null === $entity) {

0 commit comments

Comments
 (0)