Skip to content

Commit 422e5ba

Browse files
driehledriehle
authored
Merge pull request #765 from driehle/coding-standards
Updated to doctrine-coding-standard v12
2 parents 232a92a + 7b8a56c commit 422e5ba

File tree

63 files changed

+242
-480
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+242
-480
lines changed

‎composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
},
3131
"require-dev": {
3232
"doctrine/annotations": "^2.0.0",
33-
"doctrine/coding-standard": "^9.0.0",
33+
"doctrine/coding-standard": "^12.0.0",
3434
"doctrine/data-fixtures": "^1.5.2",
3535
"doctrine/migrations": "^3.8.0",
3636
"laminas/laminas-cache-storage-adapter-filesystem": "^2.0",

‎src/CliConfigurator.php

+4-11
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,8 @@ class CliConfigurator
5959
'doctrine.migrations_cmd.uptodate',
6060
];
6161

62-
private ContainerInterface $container;
63-
64-
public function __construct(ContainerInterface $container)
62+
public function __construct(private ContainerInterface $container)
6563
{
66-
$this->container = $container;
6764
}
6865

6966
public function configure(Application $cli): void
@@ -84,9 +81,7 @@ public function configure(Application $cli): void
8481
}
8582
}
8683

87-
/**
88-
* @return array<string,Helper>
89-
*/
84+
/** @return array<string,Helper> */
9085
private function getHelpers(EntityManagerInterface $objectManager): array
9186
{
9287
return [
@@ -102,7 +97,7 @@ private function createObjectManagerInputOption(): InputOption
10297
null,
10398
InputOption::VALUE_OPTIONAL,
10499
'The name of the object manager to use.',
105-
$this->defaultObjectManagerName
100+
$this->defaultObjectManagerName,
106101
);
107102
}
108103

@@ -117,9 +112,7 @@ private function getObjectManagerName(): string
117112
return $arguments->getParameterOption('--object-manager');
118113
}
119114

120-
/**
121-
* @return string[]
122-
*/
115+
/** @return string[] */
123116
private function getAvailableCommands(): array
124117
{
125118
if (class_exists(VersionCommand::class)) {

‎src/Collector/MappingCollector.php

+5-14
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,14 @@ class MappingCollector implements CollectorInterface, AutoHideInterface
2222
*/
2323
public const PRIORITY = 10;
2424

25-
protected string $name;
26-
27-
protected ?ClassMetadataFactory $classMetadataFactory = null;
25+
protected ClassMetadataFactory|null $classMetadataFactory = null;
2826

2927
/** @var ClassMetadata[] indexed by class name */
3028
protected array $classes = [];
3129

32-
public function __construct(ClassMetadataFactory $classMetadataFactory, string $name)
30+
public function __construct(ClassMetadataFactory $classMetadataFactory, protected string $name)
3331
{
3432
$this->classMetadataFactory = $classMetadataFactory;
35-
$this->name = $name;
3633
}
3734

3835
public function getName(): string
@@ -67,9 +64,7 @@ public function canHide(): bool
6764
return empty($this->classes);
6865
}
6966

70-
/**
71-
* @return array{name: string, classes: ClassMetadata[]}
72-
*/
67+
/** @return array{name: string, classes: ClassMetadata[]} */
7368
public function __serialize(): array
7469
{
7570
return [
@@ -78,18 +73,14 @@ public function __serialize(): array
7873
];
7974
}
8075

81-
/**
82-
* @param array{name: string, classes: ClassMetadata[]} $data
83-
*/
76+
/** @param array{name: string, classes: ClassMetadata[]} $data */
8477
public function __unserialize(array $data): void
8578
{
8679
$this->name = $data['name'];
8780
$this->classes = $data['classes'];
8881
}
8982

90-
/**
91-
* @return ClassMetadata[]
92-
*/
83+
/** @return ClassMetadata[] */
9384
public function getClasses(): array
9485
{
9586
return $this->classes;

‎src/Collector/SQLLoggerCollector.php

+2-10
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,8 @@ class SQLLoggerCollector implements CollectorInterface, AutoHideInterface
2121
*/
2222
public const PRIORITY = 10;
2323

24-
protected DebugStack $sqlLogger;
25-
26-
protected string $name;
27-
28-
public function __construct(DebugStack $sqlLogger, string $name)
24+
public function __construct(protected DebugStack $sqlLogger, protected string $name)
2925
{
30-
$this->sqlLogger = $sqlLogger;
31-
$this->name = $name;
3226
}
3327

3428
public function getName(): string
@@ -55,9 +49,7 @@ public function getQueryCount(): int
5549
return count($this->sqlLogger->queries);
5650
}
5751

58-
/**
59-
* @return mixed[]
60-
*/
52+
/** @return mixed[] */
6153
public function getQueries(): array
6254
{
6355
return $this->sqlLogger->queries;

‎src/ConfigProvider.php

+1-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@
99
*/
1010
final class ConfigProvider
1111
{
12-
/**
13-
* @return mixed[]
14-
*/
12+
/** @return mixed[] */
1513
public function __invoke(): array
1614
{
1715
$config = include __DIR__ . '/../config/module.config.php';

‎src/Form/Annotation/DoctrineAnnotationListener.php

+24-49
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,8 @@
1919

2020
class DoctrineAnnotationListener extends AbstractListenerAggregate
2121
{
22-
protected ObjectManager $objectManager;
23-
24-
public function __construct(ObjectManager $objectManager)
22+
public function __construct(protected ObjectManager $objectManager)
2523
{
26-
$this->objectManager = $objectManager;
2724
}
2825

2926
/**
@@ -33,45 +30,43 @@ public function attach(EventManagerInterface $events, $priority = 1)
3330
{
3431
$this->listeners[] = $events->attach(
3532
EntityBasedFormBuilder::EVENT_CONFIGURE_FIELD,
36-
[$this, 'handleFilterField']
33+
[$this, 'handleFilterField'],
3734
);
3835
$this->listeners[] = $events->attach(
3936
EntityBasedFormBuilder::EVENT_CONFIGURE_FIELD,
40-
[$this, 'handleTypeField']
37+
[$this, 'handleTypeField'],
4138
);
4239
$this->listeners[] = $events->attach(
4340
EntityBasedFormBuilder::EVENT_CONFIGURE_FIELD,
44-
[$this, 'handleValidatorField']
41+
[$this, 'handleValidatorField'],
4542
);
4643
$this->listeners[] = $events->attach(
4744
EntityBasedFormBuilder::EVENT_CONFIGURE_FIELD,
48-
[$this, 'handleRequiredField']
45+
[$this, 'handleRequiredField'],
4946
);
5047
$this->listeners[] = $events->attach(
5148
EntityBasedFormBuilder::EVENT_EXCLUDE_FIELD,
52-
[$this, 'handleExcludeField']
49+
[$this, 'handleExcludeField'],
5350
);
5451
$this->listeners[] = $events->attach(
5552
EntityBasedFormBuilder::EVENT_CONFIGURE_ASSOCIATION,
56-
[$this, 'handleToOne']
53+
[$this, 'handleToOne'],
5754
);
5855
$this->listeners[] = $events->attach(
5956
EntityBasedFormBuilder::EVENT_CONFIGURE_ASSOCIATION,
60-
[$this, 'handleToMany']
57+
[$this, 'handleToMany'],
6158
);
6259
$this->listeners[] = $events->attach(
6360
EntityBasedFormBuilder::EVENT_CONFIGURE_ASSOCIATION,
64-
[$this, 'handleRequiredAssociation']
61+
[$this, 'handleRequiredAssociation'],
6562
);
6663
$this->listeners[] = $events->attach(
6764
EntityBasedFormBuilder::EVENT_EXCLUDE_ASSOCIATION,
68-
[$this, 'handleExcludeAssociation']
65+
[$this, 'handleExcludeAssociation'],
6966
);
7067
}
7168

72-
/**
73-
* @internal
74-
*/
69+
/** @internal */
7570
public function handleToOne(EventInterface $event): void
7671
{
7772
$metadata = $event->getParam('metadata');
@@ -84,9 +79,7 @@ public function handleToOne(EventInterface $event): void
8479
$this->mergeAssociationOptions($event->getParam('elementSpec'), $mapping['targetEntity']);
8580
}
8681

87-
/**
88-
* @internal
89-
*/
82+
/** @internal */
9083
public function handleToMany(EventInterface $event): void
9184
{
9285
$metadata = $event->getParam('metadata');
@@ -106,19 +99,15 @@ public function handleToMany(EventInterface $event): void
10699
$elementSpec['spec']['attributes']['multiple'] = true;
107100
}
108101

109-
/**
110-
* @internal
111-
*/
102+
/** @internal */
112103
public function handleExcludeAssociation(EventInterface $event): bool
113104
{
114105
$metadata = $event->getParam('metadata');
115106

116107
return $metadata && $metadata->isAssociationInverseSide($event->getParam('name'));
117108
}
118109

119-
/**
120-
* @internal
121-
*/
110+
/** @internal */
122111
public function handleExcludeField(EventInterface $event): bool
123112
{
124113
$metadata = $event->getParam('metadata');
@@ -128,9 +117,7 @@ public function handleExcludeField(EventInterface $event): bool
128117
$metadata->generatorType === ClassMetadata::GENERATOR_TYPE_IDENTITY;
129118
}
130119

131-
/**
132-
* @internal
133-
*/
120+
/** @internal */
134121
public function handleFilterField(EventInterface $event): void
135122
{
136123
$metadata = $event->getParam('metadata');
@@ -165,9 +152,7 @@ public function handleFilterField(EventInterface $event): void
165152
}
166153
}
167154

168-
/**
169-
* @internal
170-
*/
155+
/** @internal */
171156
public function handleRequiredAssociation(EventInterface $event): void
172157
{
173158
$metadata = $event->getParam('metadata');
@@ -206,9 +191,7 @@ public function handleRequiredAssociation(EventInterface $event): void
206191
}
207192
}
208193

209-
/**
210-
* @internal
211-
*/
194+
/** @internal */
212195
public function handleRequiredField(EventInterface $event): void
213196
{
214197
$this->prepareEvent($event);
@@ -223,9 +206,7 @@ public function handleRequiredField(EventInterface $event): void
223206
$inputSpec['required'] = ! $metadata->isNullable($event->getParam('name'));
224207
}
225208

226-
/**
227-
* @internal
228-
*/
209+
/** @internal */
229210
public function handleTypeField(EventInterface $event): void
230211
{
231212
$metadata = $event->getParam('metadata');
@@ -281,9 +262,7 @@ public function handleTypeField(EventInterface $event): void
281262
$elementSpec['spec']['type'] = $type;
282263
}
283264

284-
/**
285-
* @internal
286-
*/
265+
/** @internal */
287266
public function handleValidatorField(EventInterface $event): void
288267
{
289268
$mapping = $this->getFieldMapping($event);
@@ -333,10 +312,8 @@ public function handleValidatorField(EventInterface $event): void
333312
}
334313
}
335314

336-
/**
337-
* @return mixed[]|null
338-
*/
339-
protected function getFieldMapping(EventInterface $event): ?array
315+
/** @return mixed[]|null */
316+
protected function getFieldMapping(EventInterface $event): array|null
340317
{
341318
$metadata = $event->getParam('metadata');
342319
if ($metadata && $metadata->hasField($event->getParam('name'))) {
@@ -346,10 +323,8 @@ protected function getFieldMapping(EventInterface $event): ?array
346323
return null;
347324
}
348325

349-
/**
350-
* @return mixed[]|null
351-
*/
352-
protected function getAssociationMapping(EventInterface $event): ?array
326+
/** @return mixed[]|null */
327+
protected function getAssociationMapping(EventInterface $event): array|null
353328
{
354329
$metadata = $event->getParam('metadata');
355330
if ($metadata && $metadata->hasAssociation($event->getParam('name'))) {
@@ -367,7 +342,7 @@ protected function mergeAssociationOptions(ArrayObject $elementSpec, string $tar
367342
'object_manager' => $this->objectManager,
368343
'target_class' => $targetEntity,
369344
],
370-
$options
345+
$options,
371346
);
372347

373348
$elementSpec['spec']['options'] = $options;

‎src/Form/Annotation/EntityBasedFormBuilder.php

+4-9
Original file line numberDiff line numberDiff line change
@@ -34,28 +34,23 @@ final class EntityBasedFormBuilder
3434

3535
protected AbstractBuilder $builder;
3636

37-
protected ObjectManager $objectManager;
38-
3937
/**
4038
* Constructor. Ensures ObjectManager is present.
4139
*/
42-
public function __construct(ObjectManager $objectManager, ?AbstractBuilder $builder = null)
40+
public function __construct(protected ObjectManager $objectManager, AbstractBuilder|null $builder = null)
4341
{
4442
if (! class_exists(AbstractBuilder::class)) {
4543
throw new RuntimeException(sprintf(
4644
'Usage of %s requires laminas-form 3.0.0 or newer, which currently is not installed.',
47-
self::class
45+
self::class,
4846
));
4947
}
5048

51-
$this->objectManager = $objectManager;
52-
$this->builder = $builder ?? new LaminasAnnotationBuilder();
49+
$this->builder = $builder ?? new LaminasAnnotationBuilder();
5350
(new DoctrineAnnotationListener($this->objectManager))->attach($this->builder->getEventManager());
5451
}
5552

56-
/**
57-
* @return AbstractBuilder the form builder from laminas-form
58-
*/
53+
/** @return AbstractBuilder the form builder from laminas-form */
5954
public function getBuilder(): AbstractBuilder
6055
{
6156
return $this->builder;

‎src/Module.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ static function (EventInterface $event): void {
3838
->get(CliConfigurator::class)
3939
->configure($event->getTarget());
4040
},
41-
1
41+
1,
4242
);
4343

4444
// Initialize logger collector in DeveloperTools
@@ -54,7 +54,7 @@ static function (EventInterface $event): void {
5454
static function ($event): void {
5555
$container = $event->getTarget()->getParam('ServiceManager');
5656
$container->get('doctrine.sql_logger_collector.orm_default');
57-
}
57+
},
5858
);
5959
}
6060

0 commit comments

Comments
 (0)