10000 feature #50846 [Bridges][Bundles] Convert to native return types (wou… · symfony/symfony@06adee2 · GitHub
[go: up one dir, main page]

Skip to content

Commit 06adee2

Browse files
feature #50846 [Bridges][Bundles] Convert to native return types (wouterj)
This PR was squashed before being merged into the 7.0 branch. Discussion ---------- [Bridges][Bundles] Convert to native return types | Q | A | ------------- | --- | Branch? | 7.0 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - The first batch of many. This is I think the easiest one: bundles and bridges contain classes that almost never get extended by third party packages. As such, I've converted all types (including void) to native ones. For the components, we should probably split up non-void types (easy merges) and void types (need close reviews). Commits ------- f90d2a9 [Bridges][Bundles] Convert to native return types
2 parents f9c9ec7 + f90d2a9 commit 06adee2

File tree

77 files changed

+148
-1720
lines changed

Some content is hidden

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

77 files changed

+148
-1720
lines changed

.github/expected-missing-return-types.diff

Lines changed: 19 additions & 1219 deletions
Large diffs are not rendered by default.

src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,7 @@ public function __construct(
3939
$this->managers = $registry->getManagerNames();
4040
}
4141

42-
/**
43-
* @return void
44-
*/
45-
public function collect(Request $request, Response $response, \Throwable $exception = null)
42+
public function collect(Request $request, Response $response, \Throwable $exception = null): void
4643
{
4744
$this->data = [
4845
'queries' => $this->collectQueries(),
@@ -62,51 +59,33 @@ private function collectQueries(): array
6259
return $queries;
6360
}
6461

65-
/**
66-
* @return void
67-
*/
68-
public function reset()
62+
public function reset(): void
6963
{
7064
$this->data = [];
7165
$this->debugDataHolder->reset();
7266
}
7367

74-
/**
75-
* @return array
76-
*/
77-
public function getManagers()
68+
public function getManagers(): array
7869
{
7970
return $this->data['managers'];
8071
}
8172

82-
/**
83-
* @return array
84-
*/
85-
public function getConnections()
73+
public function getConnections(): array
8674
{
8775
return $this->data['connections'];
8876
}
8977

90-
/**
91-
* @return int
92-
*/
93-
public function getQueryCount()
78+
public function getQueryCount(): int
9479
{
9580
return array_sum(array_map('count', $this->data['queries']));
9681
}
9782

98-
/**
99-
* @return array
100-
*/
101-
public function getQueries()
83+
public function getQueries(): array
10284
{
10385
return $this->data['queries'];
10486
}
10587

106-
/**
107-
* @return int
108-
*/
109-
public function getTime()
88+
public function getTime(): int
11089
{
11190
$time = 0;
11291
foreach ($this->data['queries'] as $queries) {

src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,9 @@ abstract class AbstractDoctrineExtension extends Extension
3838
/**
3939
* @param array $objectManager A configured object manager
4040
*
41-
* @return void
42-
*
4341
* @throws \InvalidArgumentException
4442
*/
45-
protected function loadMappingInformation(array $objectManager, ContainerBuilder $container)
43+
protected function loadMappingInformation(array $objectManager, ContainerBuilder $container): void
4644
{
4745
if ($objectManager['auto_mapping']) {
4846
// automatically register bundle mappings
@@ -107,10 +105,8 @@ protected function loadMappingInformation(array $objectManager, ContainerBuilder
107105
* Register the alias for this mapping driver.
108106
*
109107
* Aliases can be used in the Query languages of all the Doctrine object managers to simplify writing tasks.
110-
*
111-
* @return void
112108
*/
113-
protected function setMappingDriverAlias(array $mappingConfig, string $mappingName)
109+
protected function setMappingDriverAlias(array $mappingConfig, string $mappingName): void
114110
{
115111
if (isset($mappingConfig['alias'])) {
116112
$this->aliasMap[$mappingConfig['alias']] = $mappingConfig['prefix'];
@@ -122,11 +118,9 @@ protected function setMappingDriverAlias(array $mappingConfig, string $mappingNa
122118
/**
123119
* Register the mapping driver configuration for later use with the object managers metadata driver chain.
124120
*
125-
* @return void
126-
*
127121
* @throws \InvalidArgumentException
128122
*/
129-
protected function setMappingDriverConfig(array $mappingConfig, string $mappingName)
123+
protected function setMappingDriverConfig(array $mappingConfig, string $mappingName): void
130124
{
131125
$mappingDirectory = $mappingConfig['dir'];
132126
if (!is_dir($mappingDirectory)) {
@@ -178,10 +172,8 @@ protected function getMappingDriverBundleConfigDefaults(array $bundleConfig, \Re
178172

179173
/**
180174
* Register all the collected mapping information with the object manager by registering the appropriate mapping drivers.
181-
*
182-
* @return void
183175
*/
184-
protected function registerMappingDrivers(array $objectManager, ContainerBuilder $container)
176+
protected function registerMappingDrivers(array $objectManager, ContainerBuilder $container): void
185177
{
186178
// configure metadata driver for each bundle based on the type of mapping files found
187179
if ($container->hasDefinition($this->getObjectManagerElementName($objectManager['name'].'_metadata_driver'))) {
@@ -235,11 +227,9 @@ protected function registerMappingDrivers(array $objectManager, ContainerBuilder
235227
/**
236228
* Assertion if the specified mapping information is valid.
237229
*
238-
* @return void
239-
*
240230
* @throws \InvalidArgumentException
241231
*/
242-
protected function assertValidMappingConfiguration(array $mappingConfig, string $objectManagerName)
232+
protected function assertValidMappingConfiguration(array $mappingConfig, string $objectManagerName): void
243233
{
244234
if (!$mappingConfig['type'] || !$mappingConfig['dir'] || !$mappingConfig['prefix']) {
245235
throw new \InvalidArgumentException(sprintf('Mapping definitions for Doctrine manager "%s" require at least the "type", "dir" and "prefix" options.', $objectManagerName));
@@ -325,11 +315,9 @@ private function detectMappingType(string $directory, ContainerBuilder $containe
325315
/**
326316
* Loads a configured object manager metadata, query or result cache driver.
327317
*
328-
* @return void
329-
*
330318
* @throws \InvalidArgumentException in case of unknown driver type
331319
*/
332-
protected function loadObjectManagerCacheDriver(array $objectManager, ContainerBuilder $container, string $cacheName)
320+
protected function loadObjectManagerCacheDriver(array $objectManager, ContainerBuilder $container, string $cacheName): void
333321
{
334322
$this->loadCacheDriver($cacheName, $objectManager['name'], $objectManager[$cacheName.'_driver'], $container);
335323
}

src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/DoctrineValidationPass.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ public function __construct(string $managerType)
2828
$this->managerType = $managerType;
2929
}
3030

31-
/**
32-
* @return void
33-
*/
34-
public function process(ContainerBuilder $container)
31+
public function process(ContainerBuilder $container): void
3532
{
3633
$this->updateValidatorMappingFiles($container, 'xml', 'xml');
3734
$this->updateValidatorMappingFiles($container, 'yaml', 'yml');

src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterEventListenersAndSubscribersPass.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,7 @@ public function __construct(string $connectionsParameter, string $managerTemplat
5353
$this->tagPrefix = $tagPrefix;
5454
}
5555

56-
/**
57-
* @return void
58-
*/
59-
public function process(ContainerBuilder $container)
56+
public function process(ContainerBuilder $container): void
6057
{
6158
if (!$container->hasParameter($this->connectionsParameter)) {
6259
return;

src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterMappingsPass.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,8 @@ public function __construct(Definition|Reference $driver, array $namespaces, arr
130130

131131
/**
132132
* Register mappings and alias with the metadata drivers.
133-
*
134-
* @return void
135133
*/
136-
public function process(ContainerBuilder $container)
134+
public function process(ContainerBuilder $container): void
137135
{
138136
if (!$this->enabled($container)) {
139137
return;

src/Symfony/Bridge/Doctrine/DependencyInjection/Security/UserProvider/EntityFactory.php

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,7 @@ public function __construct(string $key, string $providerId)
3333
$this->providerId = $providerId;
3434
}
3535

36-
/**
37-
* @return void
38-
*/
39-
public function create(ContainerBuilder $container, string $id, array $config)
36+
public function create(ContainerBuilder $container, string $id, array $config): void
4037
{
4138
$container
4239
->setDefinition($id, new ChildDefinition($this->providerId))
@@ -46,18 +43,12 @@ public function create(ContainerBuilder $container, string $id, array $config)
4643
;
4744
}
4845

49-
/**
50-
* @return string
51-
*/
52-
public function getKey()
46+
public function getKey(): string
5347
{
5448
return $this->key;
5549
}
5650

57-
/**
58-
* @return void
59-
*/
60-
public function addConfiguration(NodeDefinition $node)
51+
public function addConfiguration(NodeDefinition $node): void
6152
{
6253
$node
6354
->children()

src/Symfony/Bridge/Doctrine/Form/DoctrineOrmTypeGuesser.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ public function guessPattern(string $class, string $property): ?ValueGuess
159159
*
160160
* @return array{0:ClassMetadata<T>, 1:string}|null
161161
*/
162-
protected function getMetadata(string $class)
162+
protected function getMetadata(string $class): ?array
163163
{
164164
// normalize class name
165165
$class = self::getRealClass(ltrim($class, '\\'));

src/Symfony/Bridge/Doctrine/Form/EventListener/MergeDoctrineCollectionListener.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,7 @@ public static function getSubscribedEvents(): array
3838
];
3939
}
4040

41-
/**
42-
* @return void
43-
*/
44-
public function onSubmit(FormEvent $event)
41+
public function onSubmit(FormEvent $event): void
4542
{
4643
$collection = $event->getForm()->getData();
4744
$data = $event->getData();

src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,7 @@ public function __construct(ManagerRegistry $registry)
9797
$this->registry = $registry;
9898
}
9999

100-
/**
101-
* @return void
102-
*/
103-
public function buildForm(FormBuilderInterface $builder, array $options)
100+
public function buildForm(FormBuilderInterface $builder, array $options): void
104101
{
105102
if ($options['multiple'] && interface_exists(Collection::class)) {
106103
$builder
@@ -110,10 +107,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
110107
}
111108
}
112109

113-
/**
114-
* @return void
115-
*/
116-
public function configureOptions(OptionsResolver $resolver)
110+
public function configureOptions(OptionsResolver $resolver): void
117111
{
118112
$choiceLoader = function (Options $options) {
119113
// Unless the choices are given explicitly, load them on demand
@@ -238,10 +232,7 @@ public function getParent(): string
238232
return ChoiceType::class;
239233
}
240234

241-
/**
242-
* @return void
243-
*/
244-
public function reset()
235+
public function reset(): void
245236
{
246237
$this->idReaders = [];
247238
$this->entityLoaders = [];

src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,7 @@
2121

2222
class EntityType extends DoctrineType
2323
{
24-
/**
25-
* @return void
26-
*/
27-
public function configureOptions(OptionsResolver $resolver)
24+
public function configureOptions(OptionsResolver $resolver): void
2825
{
2926
parent::configureOptions($resolver);
3027

src/Symfony/Bridge/Doctrine/Messenger/DoctrineClearEntityManagerWorkerSubscriber.php

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,12 @@ public function __construct(ManagerRegistry $managerRegistry)
3030
$this->managerRegistry = $managerRegistry;
3131
}
3232

33-
/**
34-
* @return void
35-
*/
36-
public function onWorkerMessageHandled()
33+
public function onWorkerMessageHandled(): void
3734
{
3835
$this->clearEntityManagers();
3936
}
4037

41-
/**
42-
* @return void
43-
*/
44-
public function onWorkerMessageFailed()
38+
public function onWorkerMessageFailed(): void
4539
{
4640
$this->clearEntityManagers();
4741
}

src/Symfony/Bridge/Doctrine/Security/RememberMe/DoctrineTokenProvider.php

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,21 +58,15 @@ public function loadTokenBySeries(string $series): PersistentTokenInterface
5858
return new PersistentToken($row['class'], $row['username'], $series, $row['value'], new \DateTime($row['last_used']));
5959
}
6060

61-
/**
62-
* @return void
63-
*/
64-
public function deleteTokenBySeries(string $series)
61+
public function deleteTokenBySeries(string $series): void
6562
{
6663
$sql = 'DELETE FROM rememberme_token WHERE series=:series';
6764
$paramValues = ['series' => $series];
6865
$paramTypes = ['series' => ParameterType::STRING];
6966
$this->conn->executeStatement($sql, $paramValues, $paramTypes);
7067
}
7168

72-
/**
73-
* @return void
74-
*/
75-
public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed)
69+
public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed): void
7670
{
7771
$sql = 'UPDATE rememberme_token SET value=:value, lastUsed=:lastUsed WHERE series=:series';
7872
$paramValues = [
@@ -92,10 +86,7 @@ public function updateToken(string $series, #[\SensitiveParameter] string $token
9286
}
9387
}
9488

95-
/**
96-
* @return void
97-
*/
98-
public function createNewToken(PersistentTokenInterface $token)
89+
public function createNewToken(PersistentTokenInterface $token): void
9990
{
10091
$sql = 'INSERT INTO rememberme_token (class, username, series, value, lastUsed) VALUES (:class, :username, :series, :value, :lastUsed)';
10192
$paramValues = [

src/Symfony/Bridge/Doctrine/Validator/Constraints/UniqueEntityValidator.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,10 @@ public function __construct(ManagerRegistry $registry)
3737
/**
3838
* @param object $entity
3939
*
40-
* @return void
41-
*
4240
* @throws UnexpectedTypeException
4341
* @throws ConstraintDefinitionException
4442
*/
45-
public function validate(mixed $entity, Constraint $constraint)
43+
public function validate(mixed $entity, Constraint $constraint): void
4644
{
4745
if (!$constraint instanceof UniqueEntity) {
4846
throw new UnexpectedTypeException($constraint, UniqueEntity::class);

src/Symfony/Bridge/Doctrine/Validator/DoctrineInitializer.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ public function __construct(ManagerRegistry $registry)
2828
$this->registry = $registry;
2929
}
3030

31-
/**
32-
* @return void
33-
*/
34-
public function initialize(object $object)
31+
public function initialize(object $object): void
3532
{
3633
$this->registry->getManagerForClass($object::class)?->initializeObject($object);
3734
}

src/Symfony/Bridge/Monolog/Command/ServerLogCommand.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,7 @@ public function isEnabled(): bool
5050
return parent::isEnabled();
5151
}
5252

53-
/**
54-
* @return void
55-
*/
56-
protected function configure()
53+
protected function configure(): void
5754
{
5855
if (!class_exists(ConsoleFormatter::class)) {
5956
return;

0 commit comments

Comments
 (0)
0