[Routing] Add types to private properties

derrabus · derrabus · commit bc5cd381b68a · 2021-09-08T15:40:31.000+02:00
diff --git a/CompiledRoute.php b/CompiledRoute.php
@@ -18,14 +18,14 @@
  */
 class CompiledRoute implements \Serializable
 {
-    private $variables;
-    private $tokens;
-    private $staticPrefix;
-    private $regex;
-    private $pathVariables;
-    private $hostVariables;
-    private $hostRegex;
-    private $hostTokens;
+    private array $variables;
+    private array $tokens;
+    private string $staticPrefix;
+    private string $regex;
+    private array $pathVariables;
+    private array $hostVariables;
+    private ?string $hostRegex;
+    private array $hostTokens;
 
     /**
      * @param string      $staticPrefix  The static prefix of the compiled route
diff --git a/Generator/CompiledUrlGenerator.php b/Generator/CompiledUrlGenerator.php
@@ -20,8 +20,8 @@
  */
 class CompiledUrlGenerator extends UrlGenerator
 {
-    private $compiledRoutes = [];
-    private $defaultLocale;
+    private array $compiledRoutes = [];
+    private ?string $defaultLocale;
 
     public function __construct(array $compiledRoutes, RequestContext $context, LoggerInterface $logger = null, string $defaultLocale = null)
     {
diff --git a/Generator/Dumper/GeneratorDumper.php b/Generator/Dumper/GeneratorDumper.php
@@ -20,7 +20,7 @@
  */
 abstract class GeneratorDumper implements GeneratorDumperInterface
 {
-    private $routes;
+    private RouteCollection $routes;
 
     public function __construct(RouteCollection $routes)
     {
diff --git a/Generator/UrlGenerator.php b/Generator/UrlGenerator.php
@@ -51,7 +51,7 @@ class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInt
 
     protected $logger;
 
-    private $defaultLocale;
+    private ?string $defaultLocale;
 
     /**
      * This array defines the characters (besides alphanumeric ones) that will not be percent-encoded in the path segment of the generated URL.
diff --git a/Loader/Configurator/CollectionConfigurator.php b/Loader/Configurator/CollectionConfigurator.php
@@ -23,10 +23,10 @@ class CollectionConfigurator
     use Traits\HostTrait;
     use Traits\RouteTrait;
 
-    private $parent;
-    private $parentConfigurator;
-    private $parentPrefixes;
-    private $host;
+    private RouteCollection $parent;
+    private ?CollectionConfigurator $parentConfigurator;
+    private ?array $parentPrefixes;
+    private string|array|null $host = null;
 
     public function __construct(RouteCollection $parent, string $name, self $parentConfigurator = null, array $parentPrefixes = null)
     {
diff --git a/Loader/Configurator/ImportConfigurator.php b/Loader/Configurator/ImportConfigurator.php
@@ -22,7 +22,7 @@ class ImportConfigurator
     use Traits\PrefixTrait;
     use Traits\RouteTrait;
 
-    private $parent;
+    private RouteCollection $parent;
 
     public function __construct(RouteCollection $parent, RouteCollection $route)
     {
diff --git a/Loader/Configurator/RoutingConfigurator.php b/Loader/Configurator/RoutingConfigurator.php
@@ -21,10 +21,10 @@ class RoutingConfigurator
 {
     use Traits\AddTrait;
 
-    private $loader;
-    private $path;
-    private $file;
-    private $env;
+    private PhpFileLoader $loader;
+    private string $path;
+    private string $file;
+    private ?string $env;
 
     public function __construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file, string $env = null)
     {
diff --git a/Loader/ContainerLoader.php b/Loader/ContainerLoader.php
@@ -20,7 +20,7 @@
  */
 class ContainerLoader extends ObjectLoader
 {
-    private $container;
+    private ContainerInterface $container;
 
     public function __construct(ContainerInterface $container, string $env = null)
     {
diff --git a/Loader/YamlFileLoader.php b/Loader/YamlFileLoader.php
@@ -36,7 +36,7 @@ class YamlFileLoader extends FileLoader
     private const AVAILABLE_KEYS = [
         'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'name_prefix', 'trailing_slash_on_root', 'locale', 'format', 'utf8', 'exclude', 'stateless',
     ];
-    private $yamlParser;
+    private YamlParser $yamlParser;
 
     /**
      * @throws \InvalidArgumentException When a route can't be parsed because YAML is invalid
@@ -53,9 +53,7 @@ public function load(mixed $file, string $type = null): RouteCollection
             throw new \InvalidArgumentException(sprintf('File "%s" not found.', $path));
         }
 
-        if (null === $this->yamlParser) {
-            $this->yamlParser = new YamlParser();
-        }
+        $this->yamlParser ??= new YamlParser();
 
         try {
             $parsedConfig = $this->yamlParser->parseFile($path, Yaml::PARSE_CONSTANT);
diff --git a/Matcher/Dumper/CompiledUrlMatcherDumper.php b/Matcher/Dumper/CompiledUrlMatcherDumper.php
@@ -26,13 +26,13 @@
  */
 class CompiledUrlMatcherDumper extends MatcherDumper
 {
-    private $expressionLanguage;
-    private $signalingException;
+    private ExpressionLanguage $expressionLanguage;
+    private ?\Exception $signalingException = null;
 
     /**
      * @var ExpressionFunctionProviderInterface[]
      */
-    private $expressionLanguageProviders = [];
+    private array $expressionLanguageProviders = [];
 
     /**
      * {@inheritdoc}
@@ -445,7 +445,7 @@ private function compileRoute(Route $route, string $name, string|array|null $var
 
     private function getExpressionLanguage(): ExpressionLanguage
     {
-        if (null === $this->expressionLanguage) {
+        if (!isset($this->expressionLanguage)) {
             if (!class_exists(ExpressionLanguage::class)) {
                 throw new \LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');
             }
diff --git a/Matcher/Dumper/CompiledUrlMatcherTrait.php b/Matcher/Dumper/CompiledUrlMatcherTrait.php
@@ -26,10 +26,10 @@
  */
 trait CompiledUrlMatcherTrait
 {
-    private $matchHost = false;
-    private $staticRoutes = [];
-    private $regexpList = [];
-    private $dynamicRoutes = [];
+    private bool $matchHost = false;
+    private array $staticRoutes = [];
+    private array $regexpList = [];
+    private array $dynamicRoutes = [];
 
     /**
      * @var callable|null
diff --git a/Matcher/Dumper/MatcherDumper.php b/Matcher/Dumper/MatcherDumper.php
@@ -20,7 +20,7 @@
  */
 abstract class MatcherDumper implements MatcherDumperInterface
 {
-    private $routes;
+    private RouteCollection $routes;
 
     public function __construct(RouteCollection $routes)
     {
diff --git a/Matcher/Dumper/StaticPrefixCollection.php b/Matcher/Dumper/StaticPrefixCollection.php
@@ -23,22 +23,22 @@
  */
 class StaticPrefixCollection
 {
-    private $prefix;
+    private string $prefix;
 
     /**
      * @var string[]
      */
-    private $staticPrefixes = [];
+    private array $staticPrefixes = [];
 
     /**
      * @var string[]
      */
-    private $prefixes = [];
+    private array $prefixes = [];
 
     /**
      * @var array[]|self[]
      */
-    private $items = [];
+    private array $items = [];
 
     public function __construct(string $prefix = '/')
     {
diff --git a/Matcher/ExpressionLanguageProvider.php b/Matcher/ExpressionLanguageProvider.php
@@ -22,7 +22,7 @@
  */
 class ExpressionLanguageProvider implements ExpressionFunctionProviderInterface
 {
-    private $functions;
+    private ServiceProviderInterface $functions;
 
     public function __construct(ServiceProviderInterface $functions)
     {
diff --git a/RequestContext.php b/RequestContext.php
@@ -23,15 +23,15 @@
  */
 class RequestContext
 {
-    private $baseUrl;
-    private $pathInfo;
-    private $method;
-    private $host;
-    private $scheme;
-    private $httpPort;
-    private $httpsPort;
-    private $queryString;
-    private $parameters = [];
+    private string $baseUrl;
+    private string $pathInfo;
+    private string $method;
+    private string $host;
+    private string $scheme;
+    private int $httpPort;
+    private int $httpsPort;
+    private string $queryString;
+    private array $parameters = [];
 
     public function __construct(string $baseUrl = '', string $method = 'GET', string $host = 'localhost', string $scheme = 'http', int $httpPort = 80, int $httpsPort = 443, string $path = '/', string $queryString = '')
     {
diff --git a/Route.php b/Route.php
@@ -19,19 +19,15 @@
  */
 class Route implements \Serializable
 {
-    private $path = '/';
-    private $host = '';
-    private $schemes = [];
-    private $methods = [];
-    private $defaults = [];
-    private $requirements = [];
-    private $options = [];
-    private $condition = '';
-
-    /**
-     * @var CompiledRoute|null
-     */
-    private $compiled;
+    private string $path = '/';
+    private string $host = '';
+    private array $schemes = [];
+    private array $methods = [];
+    private array $defaults = [];
+    private array $requirements = [];
+    private array $options = [];
+    private string $condition = '';
+    private ?CompiledRoute $compiled = null;
 
     /**
      * Constructor.
diff --git a/RouteCollection.php b/RouteCollection.php
@@ -28,17 +28,17 @@ class RouteCollection implements \IteratorAggregate, \Countable
     /**
      * @var array<string, Route>
      */
-    private $routes = [];
+    private array $routes = [];
 
     /**
      * @var array<string, ResourceInterface>
      */
-    private $resources = [];
+    private array $resources = [];
 
     /**
      * @var array<string, int>
      */
-    private $priorities = [];
+    private array $priorities = [];
 
     public function __clone()
     {
diff --git a/Router.php b/Router.php
@@ -82,17 +82,14 @@ class Router implements RouterInterface, RequestMatcherInterface
      */
     protected $defaultLocale;
 
-    /**
-     * @var ConfigCacheFactoryInterface|null
-     */
-    private $configCacheFactory;
+    private ConfigCacheFactoryInterface $configCacheFactory;
 
     /**
      * @var ExpressionFunctionProviderInterface[]
      */
-    private $expressionLanguageProviders = [];
+    private array $expressionLanguageProviders = [];
 
-    private static $cache = [];
+    private static ?array $cache = [];
 
     public function __construct(LoaderInterface $loader, mixed $resource, array $options = [], RequestContext $context = null, LoggerInterface $logger = null, string $defaultLocale = null)
     {
@@ -252,8 +249,6 @@ public function matchRequest(Request $request): array
 
     /**
      * Gets the UrlMatcher or RequestMatcher instance associated with this Router.
-     *
-     * @return UrlMatcherInterface|RequestMatcherInterface
      */
     public function getMatcher(): UrlMatcherInterface|RequestMatcherInterface
     {
@@ -349,11 +344,7 @@ protected function getMatcherDumperInstance(): MatcherDumperInterface
      */
     private function getConfigCacheFactory(): ConfigCacheFactoryInterface
     {
-        if (null === $this->configCacheFactory) {
-            $this->configCacheFactory = new ConfigCacheFactory($this->options['debug']);
-        }
-
-        return $this->configCacheFactory;
+        return $this->configCacheFactory ??= new ConfigCacheFactory($this->options['debug']);
     }
 
     private static function getCompiledRoutes(string $path): array
@@ -366,10 +357,6 @@ private static function getCompiledRoutes(string $path): array
             return require $path;
         }
 
-        if (isset(self::$cache[$path])) {
-            return self::$cache[$path];
-        }
-
-        return self::$cache[$path] = require $path;
+        return self::$cache[$path] ??= require $path;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@`
`20`	`20`	`*/`
`21`	`21`	`class CompiledUrlGenerator extends UrlGenerator`
`22`	`22`	`{`
`23`		`- private $compiledRoutes = [];`
`24`		`- private $defaultLocale;`
	`23`	`+ private array $compiledRoutes = [];`
	`24`	`+ private ?string $defaultLocale;`
`25`	`25`
`26`	`26`	`public function __construct(array $compiledRoutes, RequestContext $context, LoggerInterface $logger = null, string $defaultLocale = null)`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`abstract class GeneratorDumper implements GeneratorDumperInterface`
`22`	`22`	`{`
`23`		`- private $routes;`
	`23`	`+ private RouteCollection $routes;`
`24`	`24`
`25`	`25`	`public function __construct(RouteCollection $routes)`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class ImportConfigurator`
`22`	`22`	`use Traits\PrefixTrait;`
`23`	`23`	`use Traits\RouteTrait;`
`24`	`24`
`25`		`- private $parent;`
	`25`	`+ private RouteCollection $parent;`
`26`	`26`
`27`	`27`	`public function __construct(RouteCollection $parent, RouteCollection $route)`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,10 @@ class RoutingConfigurator`
`21`	`21`	`{`
`22`	`22`	`use Traits\AddTrait;`
`23`	`23`
`24`		`- private $loader;`
`25`		`- private $path;`
`26`		`- private $file;`
`27`		`- private $env;`
	`24`	`+ private PhpFileLoader $loader;`
	`25`	`+ private string $path;`
	`26`	`+ private string $file;`
	`27`	`+ private ?string $env;`
`28`	`28`
`29`	`29`	`public function __construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file, string $env = null)`
`30`	`30`	`{`