Add void return types

wouterj · nicolas-grekas · commit 6ac9d298c8b6 · 2023-02-13T14:18:23.000+01:00
diff --git a/Command/DebugFirewallCommand.php b/Command/DebugFirewallCommand.php
@@ -152,7 +152,7 @@ protected function displayFirewallSummary(string $name, FirewallContext $context
         );
     }
 
-    private function displaySwitchUser(FirewallContext $context, SymfonyStyle $io)
+    private function displaySwitchUser(FirewallContext $context, SymfonyStyle $io): void
     {
         if ((null === $config = $context->getConfig()) || (null === $switchUser = $config->getSwitchUser())) {
             return;
diff --git a/DataCollector/SecurityDataCollector.php b/DataCollector/SecurityDataCollector.php
@@ -55,7 +55,7 @@ public function __construct(TokenStorageInterface $tokenStorage = null, RoleHier
         $this->hasVarDumper = class_exists(ClassStub::class);
     }
 
-    public function collect(Request $request, Response $response, \Throwable $exception = null)
+    public function collect(Request $request, Response $response, \Throwable $exception = null): void
     {
         if (null === $this->tokenStorage) {
             $this->data = [
@@ -202,12 +202,12 @@ public function collect(Request $request, Response $response, \Throwable $except
         $this->data['authenticators'] = $this->firewall ? $this->firewall->getAuthenticatorsInfo() : [];
     }
 
-    public function reset()
+    public function reset(): void
     {
         $this->data = [];
     }
 
-    public function lateCollect()
+    public function lateCollect(): void
     {
         $this->data = $this->cloneVar($this->data);
     }
diff --git a/Debug/TraceableFirewallListener.php b/Debug/TraceableFirewallListener.php
@@ -41,7 +41,7 @@ public function getAuthenticatorsInfo(): array
         return $this->authenticatorsInfo;
     }
 
-    protected function callListeners(RequestEvent $event, iterable $listeners)
+    protected function callListeners(RequestEvent $event, iterable $listeners): void
     {
         $wrappedListeners = [];
         $wrappedLazyListeners = [];
diff --git a/DependencyInjection/Compiler/AddExpressionLanguageProvidersPass.php b/DependencyInjection/Compiler/AddExpressionLanguageProvidersPass.php
@@ -22,6 +22,9 @@
  */
 class AddExpressionLanguageProvidersPass implements CompilerPassInterface
 {
+    /**
+     * @return void
+     */
     public function process(ContainerBuilder $container)
     {
         if ($container->has('security.expression_language')) {
diff --git a/DependencyInjection/Compiler/AddSecurityVotersPass.php b/DependencyInjection/Compiler/AddSecurityVotersPass.php
@@ -29,6 +29,9 @@ class AddSecurityVotersPass implements CompilerPassInterface
 {
     use PriorityTaggedServiceTrait;
 
+    /**
+     * @return void
+     */
     public function process(ContainerBuilder $container)
     {
         if (!$container->hasDefinition('security.access.decision_manager')) {
diff --git a/DependencyInjection/Compiler/AddSessionDomainConstraintPass.php b/DependencyInjection/Compiler/AddSessionDomainConstraintPass.php
@@ -21,6 +21,9 @@
  */
 class AddSessionDomainConstraintPass implements CompilerPassInterface
 {
+    /**
+     * @return void
+     */
     public function process(ContainerBuilder $container)
     {
         if (!$container->hasParameter('session.storage.options') || !$container->has('security.http_utils')) {
diff --git a/DependencyInjection/Compiler/CleanRememberMeVerifierPass.php b/DependencyInjection/Compiler/CleanRememberMeVerifierPass.php
@@ -21,6 +21,9 @@
  */
 class CleanRememberMeVerifierPass implements CompilerPassInterface
 {
+    /**
+     * @return void
+     */
     public function process(ContainerBuilder $container)
     {
         if (!$container->hasDefinition('cache.system')) {
diff --git a/DependencyInjection/Compiler/MakeFirewallsEventDispatcherTraceablePass.php b/DependencyInjection/Compiler/MakeFirewallsEventDispatcherTraceablePass.php
@@ -22,6 +22,9 @@
  */
 class MakeFirewallsEventDispatcherTraceablePass implements CompilerPassInterface
 {
+    /**
+     * @return void
+     */
     public function process(ContainerBuilder $container)
     {
         if (!$container->has('event_dispatcher') || !$container->hasParameter('security.firewalls')) {
diff --git a/DependencyInjection/Compiler/RegisterCsrfFeaturesPass.php b/DependencyInjection/Compiler/RegisterCsrfFeaturesPass.php
@@ -26,13 +26,13 @@
  */
 class RegisterCsrfFeaturesPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $this->registerCsrfProtectionListener($container);
         $this->registerLogoutHandler($container);
     }
 
-    private function registerCsrfProtectionListener(ContainerBuilder $container)
+    private function registerCsrfProtectionListener(ContainerBuilder $container): void
     {
         if (!$container->has('security.authenticator.manager') || !$container->has('security.csrf.token_manager')) {
             return;
@@ -44,7 +44,7 @@ private function registerCsrfProtectionListener(ContainerBuilder $container)
             ->setPublic(false);
     }
 
-    protected function registerLogoutHandler(ContainerBuilder $container)
+    protected function registerLogoutHandler(ContainerBuilder $container): void
     {
         if (!$container->has('security.logout_listener') || !$container->has('security.csrf.token_storage')) {
             return;
diff --git a/DependencyInjection/Compiler/RegisterEntryPointPass.php b/DependencyInjection/Compiler/RegisterEntryPointPass.php
@@ -23,6 +23,9 @@
  */
 class RegisterEntryPointPass implements CompilerPassInterface
 {
+    /**
+     * @return void
+     */
     public function process(ContainerBuilder $container)
     {
         if (!$container->hasParameter('security.firewalls')) {
diff --git a/DependencyInjection/Compiler/RegisterGlobalSecurityEventListenersPass.php b/DependencyInjection/Compiler/RegisterGlobalSecurityEventListenersPass.php
@@ -52,7 +52,7 @@ class RegisterGlobalSecurityEventListenersPass implements CompilerPassInterface
         SecurityEvents::INTERACTIVE_LOGIN,
     ];
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has('event_dispatcher') || !$container->hasParameter('security.firewalls')) {
             return;
diff --git a/DependencyInjection/Compiler/RegisterLdapLocatorPass.php b/DependencyInjection/Compiler/RegisterLdapLocatorPass.php
@@ -25,7 +25,7 @@
  */
 class RegisterLdapLocatorPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $definition = $container->setDefinition('security.ldap_locator', new Definition(ServiceLocator::class));
 
diff --git a/DependencyInjection/Compiler/RegisterTokenUsageTrackingPass.php b/DependencyInjection/Compiler/RegisterTokenUsageTrackingPass.php
@@ -27,7 +27,7 @@
  */
 class RegisterTokenUsageTrackingPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has('security.untracked_token_storage')) {
             return;
diff --git a/DependencyInjection/MainConfiguration.php b/DependencyInjection/MainConfiguration.php
@@ -102,7 +102,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         return $tb;
     }
 
-    private function addRoleHierarchySection(ArrayNodeDefinition $rootNode)
+    private function addRoleHierarchySection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->fixXmlConfig('role', 'role_hierarchy')
@@ -123,7 +123,7 @@ private function addRoleHierarchySection(ArrayNodeDefinition $rootNode)
         ;
     }
 
-    private function addAccessControlSection(ArrayNodeDefinition $rootNode)
+    private function addAccessControlSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->fixXmlConfig('rule', 'access_control')
@@ -175,7 +175,7 @@ private function addAccessControlSection(ArrayNodeDefinition $rootNode)
     /**
      * @param array<array-key, AuthenticatorFactoryInterface> $factories
      */
-    private function addFirewallsSection(ArrayNodeDefinition $rootNode, array $factories)
+    private function addFirewallsSection(ArrayNodeDefinition $rootNode, array $factories): void
     {
         $firewallNodeBuilder = $rootNode
             ->fixXmlConfig('firewall')
@@ -342,7 +342,7 @@ private function addFirewallsSection(ArrayNodeDefinition $rootNode, array $facto
         ;
     }
 
-    private function addProvidersSection(ArrayNodeDefinition $rootNode)
+    private function addProvidersSection(ArrayNodeDefinition $rootNode): void
     {
         $providerNodeBuilder = $rootNode
             ->fixXmlConfig('provider')
@@ -401,7 +401,7 @@ private function addProvidersSection(ArrayNodeDefinition $rootNode)
         ;
     }
 
-    private function addPasswordHashersSection(ArrayNodeDefinition $rootNode)
+    private function addPasswordHashersSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->fixXmlConfig('password_hasher')
diff --git a/DependencyInjection/Security/Factory/AbstractFactory.php b/DependencyInjection/Security/Factory/AbstractFactory.php
@@ -52,6 +52,9 @@ final public function addOption(string $name, mixed $default = null): void
         $this->options[$name] = $default;
     }
 
+    /**
+     * @return void
+     */
     public function addConfiguration(NodeDefinition $node)
     {
         $builder = $node->children();
diff --git a/DependencyInjection/Security/Factory/CustomAuthenticatorFactory.php b/DependencyInjection/Security/Factory/CustomAuthenticatorFactory.php
@@ -35,7 +35,7 @@ public function getKey(): string
     /**
      * @param ArrayNodeDefinition $builder
      */
-    public function addConfiguration(NodeDefinition $builder)
+    public function addConfiguration(NodeDefinition $builder): void
     {
         $builder
             ->info('An array of service ids for all of your "authenticators"')
diff --git a/DependencyInjection/Security/Factory/FormLoginFactory.php b/DependencyInjection/Security/Factory/FormLoginFactory.php
@@ -50,7 +50,7 @@ public function getKey(): string
         return 'form-login';
     }
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         parent::addConfiguration($node);
 
diff --git a/DependencyInjection/Security/Factory/FormLoginLdapFactory.php b/DependencyInjection/Security/Factory/FormLoginLdapFactory.php
@@ -25,7 +25,7 @@ class FormLoginLdapFactory extends FormLoginFactory
 {
     use LdapFactoryTrait;
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         parent::addConfiguration($node);
 
diff --git a/DependencyInjection/Security/Factory/HttpBasicFactory.php b/DependencyInjection/Security/Factory/HttpBasicFactory.php
@@ -48,7 +48,7 @@ public function getKey(): string
         return 'http-basic';
     }
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         $node
             ->children()
diff --git a/DependencyInjection/Security/Factory/HttpBasicLdapFactory.php b/DependencyInjection/Security/Factory/HttpBasicLdapFactory.php
@@ -70,7 +70,7 @@ public function create(ContainerBuilder $container, string $id, array $config, s
         return [$provider, $listenerId, $entryPointId];
     }
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         parent::addConfiguration($node);
 
diff --git a/DependencyInjection/Security/Factory/JsonLoginLdapFactory.php b/DependencyInjection/Security/Factory/JsonLoginLdapFactory.php
@@ -22,7 +22,7 @@ class JsonLoginLdapFactory extends JsonLoginFactory
 {
     use LdapFactoryTrait;
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         parent::addConfiguration($node);
 
diff --git a/DependencyInjection/Security/Factory/LoginLinkFactory.php b/DependencyInjection/Security/Factory/LoginLinkFactory.php
@@ -28,7 +28,7 @@ class LoginLinkFactory extends AbstractFactory
 {
     public const PRIORITY = -20;
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         /** @var NodeBuilder $builder */
         $builder = $node->fixXmlConfig('signature_property', 'signature_properties')->children();
diff --git a/DependencyInjection/Security/Factory/LoginThrottlingFactory.php b/DependencyInjection/Security/Factory/LoginThrottlingFactory.php
@@ -44,7 +44,7 @@ public function getKey(): string
     /**
      * @param ArrayNodeDefinition $builder
      */
-    public function addConfiguration(NodeDefinition $builder)
+    public function addConfiguration(NodeDefinition $builder): void
     {
         $builder
             ->children()
@@ -87,7 +87,7 @@ public function createAuthenticator(ContainerBuilder $container, string $firewal
         return [];
     }
 
-    private function registerRateLimiter(ContainerBuilder $container, string $name, array $limiterConfig)
+    private function registerRateLimiter(ContainerBuilder $container, string $name, array $limiterConfig): void
     {
         // default configuration (when used by other DI extensions)
         $limiterConfig += ['lock_factory' => 'lock.factory', 'cache_pool' => 'cache.rate_limiter'];
diff --git a/DependencyInjection/Security/Factory/RememberMeFactory.php b/DependencyInjection/Security/Factory/RememberMeFactory.php
@@ -133,7 +133,7 @@ public function getKey(): string
         return 'remember-me';
     }
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         $builder = $node
             ->fixXmlConfig('user_provider')
@@ -235,7 +235,7 @@ private function createTokenVerifier(ContainerBuilder $container, string $firewa
         return new Reference($tokenVerifierId, ContainerInterface::NULL_ON_INVALID_REFERENCE);
     }
 
-    public function prepend(ContainerBuilder $container)
+    public function prepend(ContainerBuilder $container): void
     {
         $rememberMeSecureDefault = false;
         $rememberMeSameSiteDefault = null;
diff --git a/DependencyInjection/Security/Factory/RemoteUserFactory.php b/DependencyInjection/Security/Factory/RemoteUserFactory.php
@@ -51,7 +51,7 @@ public function getKey(): string
         return 'remote-user';
     }
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         $node
             ->children()
diff --git a/DependencyInjection/Security/Factory/X509Factory.php b/DependencyInjection/Security/Factory/X509Factory.php
@@ -52,7 +52,7 @@ public function getKey(): string
         return 'x509';
     }
 
-    public function addConfiguration(NodeDefinition $node)
+    public function addConfiguration(NodeDefinition $node): void
     {
         $node
             ->children()
diff --git a/DependencyInjection/Security/UserProvider/InMemoryFactory.php b/DependencyInjection/Security/UserProvider/InMemoryFactory.php
@@ -24,6 +24,9 @@
  */
 class InMemoryFactory implements UserProviderFactoryInterface
 {
+    /**
+     * @return void
+     */
     public function create(ContainerBuilder $container, string $id, array $config)
     {
         $definition = $container->setDefinition($id, new ChildDefinition('security.user.provider.in_memory'));
@@ -45,6 +48,9 @@ public function getKey()
         return 'memory';
     }
 
+    /**
+     * @return void
+     */
     public function addConfiguration(NodeDefinition $node)
     {
         $node
diff --git a/DependencyInjection/Security/UserProvider/LdapFactory.php b/DependencyInjection/Security/UserProvider/LdapFactory.php
@@ -24,6 +24,9 @@
  */
 class LdapFactory implements UserProviderFactoryInterface
 {
+    /**
+     * @return void
+     */
     public function create(ContainerBuilder $container, string $id, array $config)
     {
         $container
@@ -48,6 +51,9 @@ public function getKey()
         return 'ldap';
     }
 
+    /**
+     * @return void
+     */
     public function addConfiguration(NodeDefinition $node)
     {
         $node
diff --git a/EventListener/FirewallListener.php b/EventListener/FirewallListener.php
@@ -36,6 +36,9 @@ public function __construct(FirewallMapInterface $map, EventDispatcherInterface
         parent::__construct($map, $dispatcher);
     }
 
+    /**
+     * @return void
+     */
     public function configureLogoutUrlGenerator(RequestEvent $event)
     {
         if (!$event->isMainRequest()) {
@@ -47,6 +50,9 @@ public function configureLogoutUrlGenerator(RequestEvent $event)
         }
     }
 
+    /**
+     * @return void
+     */
     public function onKernelFinishRequest(FinishRequestEvent $event)
     {
         if ($event->isMainRequest()) {
diff --git a/EventListener/VoteListener.php b/EventListener/VoteListener.php
@@ -31,10 +31,7 @@ public function __construct(TraceableAccessDecisionManager $traceableAccessDecis
         $this->traceableAccessDecisionManager = $traceableAccessDecisionManager;
     }
 
-    /**
-     * Event dispatched by a voter during access manager decision.
-     */
-    public function onVoterVote(VoteEvent $event)
+    public function onVoterVote(VoteEvent $event): void
     {
         $this->traceableAccessDecisionManager->addVoterVote($event->getVoter(), $event->getAttributes(), $event->getVote());
     }
diff --git a/SecurityBundle.php b/SecurityBundle.php

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ protected function displayFirewallSummary(string $name, FirewallContext $context`
`152`	`152`	`);`
`153`	`153`	`}`
`154`	`154`
`155`		`- private function displaySwitchUser(FirewallContext $context, SymfonyStyle $io)`
	`155`	`+ private function displaySwitchUser(FirewallContext $context, SymfonyStyle $io): void`
`156`	`156`	`{`
`157`	`157`	`if ((null === $config = $context->getConfig()) \|\| (null === $switchUser = $config->getSwitchUser())) {`
`158`	`158`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public function __construct(TokenStorageInterface $tokenStorage = null, RoleHier`
`55`	`55`	`$this->hasVarDumper = class_exists(ClassStub::class);`
`56`	`56`	`}`
`57`	`57`
`58`		`- public function collect(Request $request, Response $response, \Throwable $exception = null)`
	`58`	`+ public function collect(Request $request, Response $response, \Throwable $exception = null): void`
`59`	`59`	`{`
`60`	`60`	`if (null === $this->tokenStorage) {`
`61`	`61`	`$this->data = [`
`@@ -202,12 +202,12 @@ public function collect(Request $request, Response $response, \Throwable $except`
`202`	`202`	`$this->data['authenticators'] = $this->firewall ? $this->firewall->getAuthenticatorsInfo() : [];`
`203`	`203`	`}`
`204`	`204`
`205`		`- public function reset()`
	`205`	`+ public function reset(): void`
`206`	`206`	`{`
`207`	`207`	`$this->data = [];`
`208`	`208`	`}`
`209`	`209`
`210`		`- public function lateCollect()`
	`210`	`+ public function lateCollect(): void`
`211`	`211`	`{`
`212`	`212`	`$this->data = $this->cloneVar($this->data);`
`213`	`213`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function getAuthenticatorsInfo(): array`
`41`	`41`	`return $this->authenticatorsInfo;`
`42`	`42`	`}`
`43`	`43`
`44`		`- protected function callListeners(RequestEvent $event, iterable $listeners)`
	`44`	`+ protected function callListeners(RequestEvent $event, iterable $listeners): void`
`45`	`45`	`{`
`46`	`46`	`$wrappedListeners = [];`
`47`	`47`	`$wrappedLazyListeners = [];`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@`
`22`	`22`	`*/`
`23`	`23`	`class AddExpressionLanguageProvidersPass implements CompilerPassInterface`
`24`	`24`	`{`
	`25`	`+ /**`
	`26`	`+ * @return void`
	`27`	`+ */`
`25`	`28`	`public function process(ContainerBuilder $container)`
`26`	`29`	`{`
`27`	`30`	`if ($container->has('security.expression_language')) {`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,9 @@ class AddSecurityVotersPass implements CompilerPassInterface`
`29`	`29`	`{`
`30`	`30`	`use PriorityTaggedServiceTrait;`
`31`	`31`
	`32`	`+ /**`
	`33`	`+ * @return void`
	`34`	`+ */`
`32`	`35`	`public function process(ContainerBuilder $container)`
`33`	`36`	`{`
`34`	`37`	`if (!$container->hasDefinition('security.access.decision_manager')) {`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,9 @@`
`21`	`21`	`*/`
`22`	`22`	`class AddSessionDomainConstraintPass implements CompilerPassInterface`
`23`	`23`	`{`
	`24`	`+ /**`
	`25`	`+ * @return void`
	`26`	`+ */`
`24`	`27`	`public function process(ContainerBuilder $container)`
`25`	`28`	`{`
`26`	`29`	`if (!$container->hasParameter('session.storage.options') \|\| !$container->has('security.http_utils')) {`
Original file line number	Diff line number	Diff line change
`@@ -26,13 +26,13 @@`
`26`	`26`	`*/`
`27`	`27`	`class RegisterCsrfFeaturesPass implements CompilerPassInterface`
`28`	`28`	`{`
`29`		`- public function process(ContainerBuilder $container)`
	`29`	`+ public function process(ContainerBuilder $container): void`
`30`	`30`	`{`
`31`	`31`	`$this->registerCsrfProtectionListener($container);`
`32`	`32`	`$this->registerLogoutHandler($container);`
`33`	`33`	`}`
`34`	`34`
`35`		`- private function registerCsrfProtectionListener(ContainerBuilder $container)`
	`35`	`+ private function registerCsrfProtectionListener(ContainerBuilder $container): void`
`36`	`36`	`{`
`37`	`37`	`if (!$container->has('security.authenticator.manager') \|\| !$container->has('security.csrf.token_manager')) {`
`38`	`38`	`return;`
`@@ -44,7 +44,7 @@ private function registerCsrfProtectionListener(ContainerBuilder $container)`
`44`	`44`	`->setPublic(false);`
`45`	`45`	`}`
`46`	`46`
`47`		`- protected function registerLogoutHandler(ContainerBuilder $container)`
	`47`	`+ protected function registerLogoutHandler(ContainerBuilder $container): void`
`48`	`48`	`{`
`49`	`49`	`if (!$container->has('security.logout_listener') \|\| !$container->has('security.csrf.token_storage')) {`
`50`	`50`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@`
`23`	`23`	`*/`
`24`	`24`	`class RegisterEntryPointPass implements CompilerPassInterface`
`25`	`25`	`{`
	`26`	`+ /**`
	`27`	`+ * @return void`
	`28`	`+ */`
`26`	`29`	`public function process(ContainerBuilder $container)`
`27`	`30`	`{`
`28`	`31`	`if (!$container->hasParameter('security.firewalls')) {`