Skip to content

Commit fc47953

Browse files
nicolas-grekasnicolas-grekas
committed
minor #42713 Add some missing return types to internal/final classes (nicolas-grekas)
This PR was merged into the 5.4 branch. Discussion ---------- Add some missing return types to internal/final classes | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Commits ------- 36d71ce Add some missing return types to internal/final classes
2 parents 9a2b25d + 36d71ce commit fc47953

File tree

47 files changed

+141
-359
lines changed

Some content is hidden

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

47 files changed

+141
-359
lines changed

‎src/Symfony/Bridge/Doctrine/Form/ChoiceList/IdReader.php

+1-3
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,8 @@ public function isIntId(): bool
7777
* Returns the ID value for an object.
7878
*
7979
* This method assumes that the object has a single-column ID.
80-
*
81-
* @return string
8280
*/
83-
public function getIdValue(object $object = null)
81+
public function getIdValue(object $object = null): string
8482
{
8583
if (!$object) {
8684
return '';

‎src/Symfony/Bridge/Twig/DataCollector/TwigDataCollector.php

+1-3
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@
2222
use Twig\Profiler\Profile;
2323

2424
/**
25-
* TwigDataCollector.
26-
*
2725
* @author Fabien Potencier <fabien@symfony.com>
2826
*
2927
* @final
@@ -198,7 +196,7 @@ private function computeData(Profile $profile)
198196
/**
199197
* {@inheritdoc}
200198
*/
201-
public function getName()
199+
public function getName(): string
202200
{
203201
return 'twig';
204202
}

‎src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php

+2-4
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,8 @@ public function __construct(ContainerInterface $container)
3636

3737
/**
3838
* {@inheritdoc}
39-
*
40-
* @return string[]
4139
*/
42-
public function warmUp(string $cacheDir)
40+
public function warmUp(string $cacheDir): array
4341
{
4442
$router = $this->container->get('router');
4543

@@ -51,7 +49,7 @@ public function warmUp(string $cacheDir)
5149
}
5250

5351
/**
54-
* Checks whether this warmer is optional or not.
52+
* {@inheritdoc}
5553
*/
5654
public function isOptional(): bool
5755
{

‎src/Symfony/Bundle/FrameworkBundle/Routing/DelegatingLoader.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
use Symfony\Component\Config\Exception\LoaderLoadException;
1515
use Symfony\Component\Config\Loader\DelegatingLoader as BaseDelegatingLoader;
1616
use Symfony\Component\Config\Loader\LoaderResolverInterface;
17+
use Symfony\Component\Routing\RouteCollection;
1718

1819
/**
1920
* DelegatingLoader delegates route loading to other loaders using a loader resolver.
@@ -42,7 +43,7 @@ public function __construct(LoaderResolverInterface $resolver, array $defaultOpt
4243
/**
4344
* {@inheritdoc}
4445
*/
45-
public function load($resource, string $type = null)
46+
public function load($resource, string $type = null): RouteCollection
4647
{
4748
if ($this->loading) {
4849
// This can happen if a fatal error occurs in parent::load().

‎src/Symfony/Bundle/SecurityBundle/DataCollector/SecurityDataCollector.php

+11-34
Original file line numberDiff line numberDiff line change
@@ -232,20 +232,16 @@ public function lateCollect()
232232

233233
/**
234234
* Checks if security is enabled.
235-
*
236-
* @return bool
237235
*/
238-
public function isEnabled()
236+
public function isEnabled(): bool
239237
{
240238
return $this->data['enabled'];
241239
}
242240

243241
/**
244242
* Gets the user.
245-
*
246-
* @return string
247243
*/
248-
public function getUser()
244+
public function getUser(): string
249245
{
250246
return $this->data['user'];
251247
}
@@ -273,44 +269,31 @@ public function getInheritedRoles()
273269
/**
274270
* Checks if the data contains information about inherited roles. Still the inherited
275271
* roles can be an empty array.
276-
*
277-
* @return bool
278272
*/
279-
public function supportsRoleHierarchy()
273+
public function supportsRoleHierarchy(): bool
280274
{
281275
return $this->data['supports_role_hierarchy'];
282276
}
283277

284278
/**
285279
* Checks if the user is authenticated or not.
286-
*
287-
* @return bool
288280
*/
289-
public function isAuthenticated()
281+
public function isAuthenticated(): bool
290282
{
291283
return $this->data['authenticated'];
292284
}
293285

294-
/**
295-
* @return bool
296-
*/
297-
public function isImpersonated()
286+
public function isImpersonated(): bool
298287
{
299288
return $this->data['impersonated'];
300289
}
301290

302-
/**
303-
* @return string|null
304-
*/
305-
public function getImpersonatorUser()
291+
public function getImpersonatorUser(): ?string
306292
{
307293
return $this->data['impersonator_user'];
308294
}
309295

310-
/**
311-
* @return string|null
312-
*/
313-
public function getImpersonationExitPath()
296+
public function getImpersonationExitPath(): ?string
314297
{
315298
return $this->data['impersonation_exit_path'];
316299
}
@@ -327,20 +310,16 @@ public function getTokenClass()
327310

328311
/**
329312
* Get the full security token class as Data object.
330-
*
331-
* @return Data|null
332313
*/
333-
public function getToken()
314+
public function getToken(): ?Data
334315
{
335316
return $this->data['token'];
336317
}
337318

338319
/**
339320
* Get the logout URL.
340-
*
341-
* @return string|null
342321
*/
343-
public function getLogoutUrl()
322+
public function getLogoutUrl(): ?string
344323
{
345324
return $this->data['logout_url'];
346325
}
@@ -357,10 +336,8 @@ public function getVoters()
357336

358337
/**
359338
* Returns the strategy configured for the security voters.
360-
*
361-
* @return string
362339
*/
363-
public function getVoterStrategy()
340+
public function getVoterStrategy(): string
364341
{
365342
return $this->data['voter_strategy'];
366343
}
@@ -396,7 +373,7 @@ public function getListeners()
396373
/**
397374
* {@inheritdoc}
398375
*/
399-
public function getName()
376+
public function getName(): string
400377
{
401378
return 'security';
402379
}

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/AnonymousFactory.php

-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@
2020
/**
2121
* @author Wouter de Jong <wouter@wouterj.nl>
2222
*
23-
* @internal
24-
*
2523
* @deprecated since Symfony 5.3, use the new authenticator system instead
2624
*/
2725
class AnonymousFactory implements SecurityFactoryInterface, AuthenticatorFactoryInterface

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/CustomAuthenticatorFactory.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
*/
2323
class CustomAuthenticatorFactory implements AuthenticatorFactoryInterface, SecurityFactoryInterface
2424
{
25-
public function create(ContainerBuilder $container, string $id, array $config, string $userProvider, ?string $defaultEntryPoint)
25+
public function create(ContainerBuilder $container, string $id, array $config, string $userProvider, ?string $defaultEntryPoint): array
2626
{
2727
throw new \LogicException('Custom authenticators are not supported when "security.enable_authenticator_manager" is not set to true.');
2828
}

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/FormLoginFactory.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ public function getPriority(): int
4444
return self::PRIORITY;
4545
}
4646

47-
public function getPosition()
47+
public function getPosition(): string
4848
{
4949
return 'form';
5050
}
5151

52-
public function getKey()
52+
public function getKey(): string
5353
{
5454
return 'form-login';
5555
}
@@ -65,12 +65,12 @@ public function addConfiguration(NodeDefinition $node)
6565
;
6666
}
6767

68-
protected function getListenerId()
68+
protected function getListenerId(): string
6969
{
7070
return 'security.authentication.listener.form';
7171
}
7272

73-
protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId)
73+
protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId): string
7474
{
7575
if ($config['enable_csrf'] ?? false) {
7676
throw new InvalidConfigurationException('The "enable_csrf" option of "form_login" is only available when "security.enable_authenticator_manager" is set to "true", use "csrf_token_generator" instead.');
@@ -99,7 +99,7 @@ protected function createListener(ContainerBuilder $container, string $id, array
9999
return $listenerId;
100100
}
101101

102-
protected function createEntryPoint(ContainerBuilder $container, string $id, array $config, ?string $defaultEntryPointId)
102+
protected function createEntryPoint(ContainerBuilder $container, string $id, array $config, ?string $defaultEntryPointId): ?string
103103
{
104104
$entryPointId = 'security.authentication.form_entry_point.'.$id;
105105
$container

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/FormLoginLdapFactory.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class FormLoginLdapFactory extends FormLoginFactory
2929
{
3030
use LdapFactoryTrait;
3131

32-
protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId)
32+
protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId): string
3333
{
3434
$provider = 'security.authentication.provider.ldap_bind.'.$id;
3535
$definition = $container

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/GuardAuthenticationFactory.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
*/
3030
class GuardAuthenticationFactory implements SecurityFactoryInterface, AuthenticatorFactoryInterface
3131
{
32-
public function getPosition()
32+
public function getPosition(): string
3333
{
3434
return 'pre_auth';
3535
}
@@ -39,7 +39,7 @@ public function getPriority(): int
3939
return 0;
4040
}
4141

42-
public function getKey()
42+
public function getKey(): string
4343
{
4444
return 'guard';
4545
}
@@ -65,7 +65,7 @@ public function addConfiguration(NodeDefinition $node)
6565
;
6666
}
6767

68-
public function create(ContainerBuilder $container, string $id, array $config, string $userProvider, ?string $defaultEntryPoint)
68+
public function create(ContainerBuilder $container, string $id, array $config, string $userProvider, ?string $defaultEntryPoint): array
6969
{
7070
$authenticatorIds = $config['authenticators'];
7171
$authenticatorReferences = [];

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/HttpBasicFactory.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class HttpBasicFactory implements SecurityFactoryInterface, AuthenticatorFactory
2727
{
2828
public const PRIORITY = -50;
2929

30-
public function create(ContainerBuilder $container, string $id, array $config, string $userProvider, ?string $defaultEntryPoint)
30+
public function create(ContainerBuilder $container, string $id, array $config, string $userProvider, ?string $defaultEntryPoint): array
3131
{
3232
$provider = 'security.authentication.provider.dao.'.$id;
3333
$container
@@ -73,12 +73,12 @@ public function getPriority(): int
7373
return self::PRIORITY;
7474
}
7575

76-
public function getPosition()
76+
public function getPosition(): string
7777
{
7878
return 'http';
7979
}
8080

81-
public function getKey()
81+
public function getKey(): string
8282
{
8383
return 'http-basic';
8484
}

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/HttpBasicLdapFactory.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class HttpBasicLdapFactory extends HttpBasicFactory
3030
{
3131
use LdapFactoryTrait;
3232

33-
public function create(ContainerBuilder $container, string $id, array $config, string $userProvider, ?string $defaultEntryPoint)
33+
public function create(ContainerBuilder $container, string $id, array $config, string $userProvider, ?string $defaultEntryPoint): array
3434
{
3535
$provider = 'security.authentication.provider.ldap_bind.'.$id;
3636
$definition = $container

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/JsonLoginFactory.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -42,23 +42,23 @@ public function getPriority(): int
4242
/**
4343
* {@inheritdoc}
4444
*/
45-
public function getPosition()
45+
public function getPosition(): string
4646
{
4747
return 'form';
4848
}
4949

5050
/**
5151
* {@inheritdoc}
5252
*/
53-
public function getKey()
53+
public function getKey(): string
5454
{
5555
return 'json-login';
5656
}
5757

5858
/**
5959
* {@inheritdoc}
6060
*/
61-
protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId)
61+
protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId): string
6262
{
6363
$provider = 'security.authentication.provider.dao.'.$id;
6464
$container
@@ -74,15 +74,15 @@ protected function createAuthProvider(ContainerBuilder $container, string $id, a
7474
/**
7575
* {@inheritdoc}
7676
*/
77-
protected function getListenerId()
77+
protected function getListenerId(): string
7878
{
7979
return 'security.authentication.listener.json';
8080
}
8181

8282
/**
8383
* {@inheritdoc}
8484
*/
85-
protected function isRememberMeAware(array $config)
85+
protected function isRememberMeAware(array $config): bool
8686
{
8787
return false;
8888
}

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/JsonLoginLdapFactory.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class JsonLoginLdapFactory extends JsonLoginFactory
2626
{
2727
use LdapFactoryTrait;
2828

29-
protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId)
29+
protected function createAuthProvider(ContainerBuilder $container, string $id, array $config, string $userProviderId): string
3030
{
3131
$provider = 'security.authentication.provider.ldap_bind.'.$id;
3232
$definition = $container

0 commit comments

Comments
 (0)