[Security] Add types to private properties

derrabus · derrabus · commit 83c986a7d030 · 2021-11-02T21:30:51.000+01:00
Signed-off-by: Alexander M. Turek &lt;me@derrabus.de&gt;
diff --git a/CacheWarmer/ExpressionCacheWarmer.php b/CacheWarmer/ExpressionCacheWarmer.php
@@ -17,11 +17,11 @@
 
 class ExpressionCacheWarmer implements CacheWarmerInterface
 {
-    private $expressions;
-    private $expressionLanguage;
+    private iterable $expressions;
+    private ExpressionLanguage $expressionLanguage;
 
     /**
-     * @param iterable|Expression[] $expressions
+     * @param iterable<mixed, Expression|string> $expressions
      */
     public function __construct(iterable $expressions, ExpressionLanguage $expressionLanguage)
     {
diff --git a/Command/DebugFirewallCommand.php b/Command/DebugFirewallCommand.php
@@ -32,10 +32,10 @@
 #[AsCommand(name: 'debug:firewall', description: 'Display information about your security firewall(s)')]
 final class DebugFirewallCommand extends Command
 {
-    private $firewallNames;
-    private $contexts;
-    private $eventDispatchers;
-    private $authenticators;
+    private array $firewallNames;
+    private ContainerInterface $contexts;
+    private ContainerInterface $eventDispatchers;
+    private array $authenticators;
 
     /**
      * @param string[]                   $firewallNames
diff --git a/DataCollector/SecurityDataCollector.php b/DataCollector/SecurityDataCollector.php
@@ -36,13 +36,13 @@
  */
 class SecurityDataCollector extends DataCollector implements LateDataCollectorInterface
 {
-    private $tokenStorage;
-    private $roleHierarchy;
-    private $logoutUrlGenerator;
-    private $accessDecisionManager;
-    private $firewallMap;
-    private $firewall;
-    private $hasVarDumper;
+    private ?TokenStorageInterface $tokenStorage;
+    private ?RoleHierarchyInterface $roleHierarchy;
+    private ?LogoutUrlGenerator $logoutUrlGenerator;
+    private ?AccessDecisionManagerInterface $accessDecisionManager;
+    private ?FirewallMapInterface $firewallMap;
+    private ?TraceableFirewallListener $firewall;
+    private bool $hasVarDumper;
 
     public function __construct(TokenStorageInterface $tokenStorage = null, RoleHierarchyInterface $roleHierarchy = null, LogoutUrlGenerator $logoutUrlGenerator = null, AccessDecisionManagerInterface $accessDecisionManager = null, FirewallMapInterface $firewallMap = null, TraceableFirewallListener $firewall = null)
     {
diff --git a/Debug/TraceableFirewallListener.php b/Debug/TraceableFirewallListener.php
@@ -25,8 +25,8 @@
  */
 final class TraceableFirewallListener extends FirewallListener
 {
-    private $wrappedListeners = [];
-    private $authenticatorsInfo = [];
+    private array $wrappedListeners = [];
+    private array $authenticatorsInfo = [];
 
     public function getWrappedListeners()
     {
diff --git a/Debug/TraceableListenerTrait.php b/Debug/TraceableListenerTrait.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\SecurityBundle\Debug;
 
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Http\Authenticator\Debug\TraceableAuthenticatorManagerListener;
 use Symfony\Component\VarDumper\Caster\ClassStub;
 
@@ -21,10 +22,10 @@
  */
 trait TraceableListenerTrait
 {
-    private $response;
-    private $listener;
-    private $time;
-    private $stub;
+    private ?Response $response = null;
+    private mixed $listener;
+    private ?float $time = null;
+    private object $stub;
 
     /**
      * Proxies all method calls to the original listener.
diff --git a/DependencyInjection/MainConfiguration.php b/DependencyInjection/MainConfiguration.php
@@ -36,8 +36,8 @@ class MainConfiguration implements ConfigurationInterface
     /** @internal */
     public const STRATEGY_PRIORITY = 'priority';
 
-    private $factories;
-    private $userProviderFactories;
+    private array $factories;
+    private array $userProviderFactories;
 
     /**
      * @param AuthenticatorFactoryInterface[] $factories
diff --git a/DependencyInjection/SecurityExtension.php b/DependencyInjection/SecurityExtension.php
@@ -55,14 +55,14 @@
  */
 class SecurityExtension extends Extension implements PrependExtensionInterface
 {
-    private $requestMatchers = [];
-    private $expressions = [];
-    private $contextListeners = [];
+    private array $requestMatchers = [];
+    private array $expressions = [];
+    private array $contextListeners = [];
     /** @var list<array{0: int, 1: AuthenticatorFactoryInterface}> */
-    private $factories = [];
+    private array $factories = [];
     /** @var AuthenticatorFactoryInterface[] */
-    private $sortedFactories = [];
-    private $userProviderFactories = [];
+    private array $sortedFactories = [];
+    private array $userProviderFactories = [];
 
     public function prepend(ContainerBuilder $container)
     {
diff --git a/EventListener/FirewallListener.php b/EventListener/FirewallListener.php
@@ -25,8 +25,8 @@
  */
 class FirewallListener extends Firewall
 {
-    private $map;
-    private $logoutUrlGenerator;
+    private FirewallMapInterface $map;
+    private LogoutUrlGenerator $logoutUrlGenerator;
 
     public function __construct(FirewallMapInterface $map, EventDispatcherInterface $dispatcher, LogoutUrlGenerator $logoutUrlGenerator)
     {
diff --git a/EventListener/VoteListener.php b/EventListener/VoteListener.php
@@ -24,7 +24,7 @@
  */
 class VoteListener implements EventSubscriberInterface
 {
-    private $traceableAccessDecisionManager;
+    private TraceableAccessDecisionManager $traceableAccessDecisionManager;
 
     public function __construct(TraceableAccessDecisionManager $traceableAccessDecisionManager)
     {
diff --git a/RememberMe/DecoratedRememberMeHandler.php b/RememberMe/DecoratedRememberMeHandler.php
@@ -24,7 +24,7 @@
  */
 final class DecoratedRememberMeHandler implements RememberMeHandlerInterface
 {
-    private $handler;
+    private RememberMeHandlerInterface $handler;
 
     public function __construct(RememberMeHandlerInterface $handler)
     {
diff --git a/Security/FirewallAwareTrait.php b/Security/FirewallAwareTrait.php
@@ -11,6 +11,9 @@
 
 namespace Symfony\Bundle\SecurityBundle\Security;
 
+use Psr\Container\ContainerInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+
 /**
  * Provides basic functionality for services mapped by the firewall name
  * in a container locator.
@@ -21,9 +24,9 @@
  */
 trait FirewallAwareTrait
 {
-    private $locator;
-    private $requestStack;
-    private $firewallMap;
+    private ContainerInterface $locator;
+    private RequestStack $requestStack;
+    private FirewallMap $firewallMap;
 
     private function getForFirewall(): object
     {
diff --git a/Security/FirewallConfig.php b/Security/FirewallConfig.php
@@ -16,18 +16,18 @@
  */
 final class FirewallConfig
 {
-    private $name;
-    private $userChecker;
-    private $requestMatcher;
-    private $securityEnabled;
-    private $stateless;
-    private $provider;
-    private $context;
-    private $entryPoint;
-    private $accessDeniedHandler;
-    private $accessDeniedUrl;
-    private $authenticators;
-    private $switchUser;
+    private string $name;
+    private string $userChecker;
+    private ?string $requestMatcher;
+    private bool $securityEnabled;
+    private bool $stateless;
+    private ?string $provider;
+    private ?string $context;
+    private ?string $entryPoint;
+    private ?string $accessDeniedHandler;
+    private ?string $accessDeniedUrl;
+    private array $authenticators;
+    private ?array $switchUser;
 
     public function __construct(string $name, string $userChecker, string $requestMatcher = null, bool $securityEnabled = true, bool $stateless = false, string $provider = null, string $context = null, string $entryPoint = null, string $accessDeniedHandler = null, string $accessDeniedUrl = null, array $authenticators = [], array $switchUser = null)
     {
diff --git a/Security/FirewallContext.php b/Security/FirewallContext.php
@@ -22,10 +22,10 @@
  */
 class FirewallContext
 {
-    private $listeners;
-    private $exceptionListener;
-    private $logoutListener;
-    private $config;
+    private iterable $listeners;
+    private ?ExceptionListener $exceptionListener;
+    private ?LogoutListener $logoutListener;
+    private ?FirewallConfig $config;
 
     public function __construct(iterable $listeners, ExceptionListener $exceptionListener = null, LogoutListener $logoutListener = null, FirewallConfig $config = null)
     {
diff --git a/Security/FirewallMap.php b/Security/FirewallMap.php
@@ -24,8 +24,8 @@
  */
 class FirewallMap implements FirewallMapInterface
 {
-    private $container;
-    private $map;
+    private ContainerInterface $container;
+    private iterable $map;
 
     public function __construct(ContainerInterface $container, iterable $map)
     {
diff --git a/Security/LazyFirewallContext.php b/Security/LazyFirewallContext.php
@@ -25,7 +25,7 @@
  */
 class LazyFirewallContext extends FirewallContext
 {
-    private $tokenStorage;
+    private TokenStorage $tokenStorage;
 
     public function __construct(iterable $listeners, ?ExceptionListener $exceptionListener, ?LogoutListener $logoutListener, ?FirewallConfig $config, TokenStorage $tokenStorage)
     {

Original file line number	Diff line number	Diff line change
`@@ -17,11 +17,11 @@`
`17`	`17`
`18`	`18`	`class ExpressionCacheWarmer implements CacheWarmerInterface`
`19`	`19`	`{`
`20`		`- private $expressions;`
`21`		`- private $expressionLanguage;`
	`20`	`+ private iterable $expressions;`
	`21`	`+ private ExpressionLanguage $expressionLanguage;`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * @param iterable\|Expression[] $expressions`
	`24`	`+ * @param iterable<mixed, Expression\|string> $expressions`
`25`	`25`	`*/`
`26`	`26`	`public function __construct(iterable $expressions, ExpressionLanguage $expressionLanguage)`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,8 @@`
`25`	`25`	`*/`
`26`	`26`	`final class TraceableFirewallListener extends FirewallListener`
`27`	`27`	`{`
`28`		`- private $wrappedListeners = [];`
`29`		`- private $authenticatorsInfo = [];`
	`28`	`+ private array $wrappedListeners = [];`
	`29`	`+ private array $authenticatorsInfo = [];`
`30`	`30`
`31`	`31`	`public function getWrappedListeners()`
`32`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`*/`
`25`	`25`	`class VoteListener implements EventSubscriberInterface`
`26`	`26`	`{`
`27`		`- private $traceableAccessDecisionManager;`
	`27`	`+ private TraceableAccessDecisionManager $traceableAccessDecisionManager;`
`28`	`28`
`29`	`29`	`public function __construct(TraceableAccessDecisionManager $traceableAccessDecisionManager)`
`30`	`30`	`{`