Replace more docblocks by type-hints

nicolas-grekas · nicolas-grekas · commit faffea9e427c · 2017-11-07T15:45:01.000+01:00
diff --git a/CompiledRoute.php b/CompiledRoute.php
@@ -37,9 +37,9 @@ class CompiledRoute implements \Serializable
      * @param array       $hostVariables An array of host variables
      * @param array       $variables     An array of variables (variables defined in the path and in the host patterns)
      */
-    public function __construct($staticPrefix, $regex, array $tokens, array $pathVariables, $hostRegex = null, array $hostTokens = array(), array $hostVariables = array(), array $variables = array())
+    public function __construct(string $staticPrefix, string $regex, array $tokens, array $pathVariables, string $hostRegex = null, array $hostTokens = array(), array $hostVariables = array(), array $variables = array())
     {
-        $this->staticPrefix = (string) $staticPrefix;
+        $this->staticPrefix = $staticPrefix;
         $this->regex = $regex;
         $this->tokens = $tokens;
         $this->pathVariables = $pathVariables;
diff --git a/DependencyInjection/RoutingResolverPass.php b/DependencyInjection/RoutingResolverPass.php
@@ -28,7 +28,7 @@ class RoutingResolverPass implements CompilerPassInterface
     private $resolverServiceId;
     private $loaderTag;
 
-    public function __construct($resolverServiceId = 'routing.resolver', $loaderTag = 'routing.loader')
+    public function __construct(string $resolverServiceId = 'routing.resolver', string $loaderTag = 'routing.loader')
     {
         $this->resolverServiceId = $resolverServiceId;
         $this->loaderTag = $loaderTag;
diff --git a/Exception/MethodNotAllowedException.php b/Exception/MethodNotAllowedException.php
@@ -22,7 +22,7 @@ class MethodNotAllowedException extends \RuntimeException implements ExceptionIn
 {
     protected $allowedMethods = array();
 
-    public function __construct(array $allowedMethods, $message = null, $code = 0, \Exception $previous = null)
+    public function __construct(array $allowedMethods, string $message = null, int $code = 0, \Exception $previous = null)
     {
         $this->allowedMethods = array_map('strtoupper', $allowedMethods);
 
diff --git a/Loader/Configurator/CollectionConfigurator.php b/Loader/Configurator/CollectionConfigurator.php
@@ -24,7 +24,7 @@ class CollectionConfigurator
 
     private $parent;
 
-    public function __construct(RouteCollection $parent, $name)
+    public function __construct(RouteCollection $parent, string $name)
     {
         $this->parent = $parent;
         $this->name = $name;
@@ -40,13 +40,8 @@ public function __destruct()
 
     /**
      * Adds a route.
-     *
-     * @param string $name
-     * @param string $path
-     *
-     * @return RouteConfigurator
      */
-    final public function add($name, $path)
+    final public function add(string $name, string $path): RouteConfigurator
     {
         $this->collection->add($this->name.$name, $route = clone $this->route);
 
@@ -66,11 +61,9 @@ final public function collection($name = '')
     /**
      * Sets the prefix to add to the path of all child routes.
      *
-     * @param string $prefix
-     *
      * @return $this
      */
-    final public function prefix($prefix)
+    final public function prefix(string $prefix)
     {
         $this->route->setPath($prefix);
 
diff --git a/Loader/Configurator/ImportConfigurator.php b/Loader/Configurator/ImportConfigurator.php
@@ -36,11 +36,9 @@ public function __destruct()
     /**
      * Sets the prefix to add to the path of all child routes.
      *
-     * @param string $prefix
-     *
      * @return $this
      */
-    final public function prefix($prefix)
+    final public function prefix(string $prefix)
     {
         $this->route->addPrefix($prefix);
 
diff --git a/Loader/Configurator/RouteConfigurator.php b/Loader/Configurator/RouteConfigurator.php
@@ -22,7 +22,7 @@ class RouteConfigurator
     use Traits\AddTrait;
     use Traits\RouteTrait;
 
-    public function __construct(RouteCollection $collection, Route $route, $name = '')
+    public function __construct(RouteCollection $collection, Route $route, string $name = '')
     {
         $this->collection = $collection;
         $this->route = $route;
diff --git a/Loader/Configurator/RoutingConfigurator.php b/Loader/Configurator/RoutingConfigurator.php
@@ -25,7 +25,7 @@ class RoutingConfigurator
     private $path;
     private $file;
 
-    public function __construct(RouteCollection $collection, PhpFileLoader $loader, $path, $file)
+    public function __construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file)
     {
         $this->collection = $collection;
         $this->loader = $loader;
diff --git a/Loader/Configurator/Traits/AddTrait.php b/Loader/Configurator/Traits/AddTrait.php
@@ -26,13 +26,8 @@ trait AddTrait
 
     /**
      * Adds a route.
-     *
-     * @param string $name
-     * @param string $path
-     *
-     * @return RouteConfigurator
      */
-    final public function add($name, $path)
+    final public function add(string $name, string $path): RouteConfigurator
     {
         $this->collection->add($this->name.$name, $route = new Route($path));
 
@@ -41,13 +36,8 @@ final public function add($name, $path)
 
     /**
      * Adds a route.
-     *
-     * @param string $name
-     * @param string $path
-     *
-     * @return RouteConfigurator
      */
-    final public function __invoke($name, $path)
+    final public function __invoke(string $name, string $path): RouteConfigurator
     {
         return $this->add($name, $path);
     }
diff --git a/Loader/Configurator/Traits/RouteTrait.php b/Loader/Configurator/Traits/RouteTrait.php
@@ -60,11 +60,9 @@ final public function options(array $options)
     /**
      * Sets the condition.
      *
-     * @param string $condition
-     *
      * @return $this
      */
-    final public function condition($condition)
+    final public function condition(string $condition)
     {
         $this->route->setCondition($condition);
 
@@ -74,11 +72,9 @@ final public function condition($condition)
     /**
      * Sets the pattern for the host.
      *
-     * @param string $pattern
-     *
      * @return $this
      */
-    final public function host($pattern)
+    final public function host(string $pattern)
     {
         $this->route->setHost($pattern);
 
diff --git a/Matcher/Dumper/StaticPrefixCollection.php b/Matcher/Dumper/StaticPrefixCollection.php
@@ -132,10 +132,6 @@ private function groupWithItem($item, string $prefix, $route)
 
     /**
      * Checks whether a prefix can be contained within the group.
-     *
-     * @param string $prefix
-     *
-     * @return bool Whether a prefix could belong in a given group
      */
     private function accepts(string $prefix): bool
     {
@@ -145,9 +141,6 @@ private function accepts(string $prefix): bool
     /**
      * Detects whether there's a common prefix relative to the group prefix and returns it.
      *
-     * @param string $prefix
-     * @param string $anotherPrefix
-     *
      * @return false|string A common prefix, longer than the base/group prefix, or false when none available
      */
     private function detectCommonPrefix(string $prefix, string $anotherPrefix)
@@ -223,8 +216,6 @@ private function shouldBeInlined(): bool
     /**
      * Guards against adding incompatible prefixes in a group.
      *
-     * @param string $prefix
-     *
      * @throws \LogicException when a prefix does not belong in a group
      */
     private function guardAgainstAddingNotAcceptedRoutes(string $prefix)
diff --git a/RequestContext.php b/RequestContext.php
@@ -33,17 +33,7 @@ class RequestContext
     private $queryString;
     private $parameters = array();
 
-    /**
-     * @param string $baseUrl     The base URL
-     * @param string $method      The HTTP method
-     * @param string $host        The HTTP host name
-     * @param string $scheme      The HTTP scheme
-     * @param int    $httpPort    The HTTP port
-     * @param int    $httpsPort   The HTTPS port
-     * @param string $path        The path
-     * @param string $queryString The query string
-     */
-    public function __construct($baseUrl = '', $method = 'GET', $host = 'localhost', $scheme = 'http', $httpPort = 80, $httpsPort = 443, $path = '/', $queryString = '')
+    public function __construct(string $baseUrl = '', string $method = 'GET', string $host = 'localhost', string $scheme = 'http', int $httpPort = 80, int $httpsPort = 443, string $path = '/', string $queryString = '')
     {
         $this->setBaseUrl($baseUrl);
         $this->setMethod($method);
diff --git a/Route.php b/Route.php
@@ -48,7 +48,7 @@ class Route implements \Serializable
      * @param string|string[] $methods      A required HTTP method or an array of restricted methods
      * @param string          $condition    A condition that should evaluate to true for the route to match
      */
-    public function __construct($path, array $defaults = array(), array $requirements = array(), array $options = array(), $host = '', $schemes = array(), $methods = array(), $condition = '')
+    public function __construct(string $path, array $defaults = array(), array $requirements = array(), array $options = array(), ?string $host = '', $schemes = array(), $methods = array(), ?string $condition = '')
     {
         $this->setPath($path);
         $this->setDefaults($defaults);
diff --git a/RouteCollectionBuilder.php b/RouteCollectionBuilder.php
@@ -326,10 +326,8 @@ public function build()
 
     /**
      * Generates a route name based on details of this route.
-     *
-     * @return string
      */
-    private function generateRouteName(Route $route)
+    private function generateRouteName(Route $route): string
     {
         $methods = implode('_', $route->getMethods()).'_';
 
diff --git a/RouteCompiler.php b/RouteCompiler.php
@@ -230,10 +230,8 @@ private static function compilePattern(Route $route, $pattern, $isHost)
 
     /**
      * Determines the longest static prefix possible for a route.
-     *
-     * @return string The leading static part of a route's path
      */
-    private static function determineStaticPrefix(Route $route, array $tokens)
+    private static function determineStaticPrefix(Route $route, array $tokens): string
     {
         if ('text' !== $tokens[0][0]) {
             return ($route->hasDefault($tokens[0][3]) || '/' === $tokens[0][1]) ? '' : $tokens[0][1];
@@ -249,14 +247,9 @@ private static function determineStaticPrefix(Route $route, array $tokens)
     }
 
     /**
-     * Returns the next static character in the Route pattern that will serve as a separator.
-     *
-     * @param string $pattern The route pattern
-     * @param bool   $useUtf8 Whether the character is encoded in UTF-8 or not
-     *
-     * @return string The next static character that functions as separator (or empty string when none available)
+     * Returns the next static character in the Route pattern that will serve as a separator (or the empty string when none available)
      */
-    private static function findNextSeparator($pattern, $useUtf8)
+    private static function findNextSeparator(string $pattern, bool $useUtf8): string
     {
         if ('' == $pattern) {
             // return empty string if pattern is empty or false (false which can be returned by substr)
@@ -282,7 +275,7 @@ private static function findNextSeparator($pattern, $useUtf8)
      *
      * @return string The regexp pattern for a single token
      */
-    private static function computeRegexp(array $tokens, $index, $firstOptional)
+    private static function computeRegexp(array $tokens, int $index, int $firstOptional): string
     {
         $token = $tokens[$index];
         if ('text' === $token[0]) {

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class RoutingResolverPass implements CompilerPassInterface`
`28`	`28`	`private $resolverServiceId;`
`29`	`29`	`private $loaderTag;`
`30`	`30`
`31`		`- public function __construct($resolverServiceId = 'routing.resolver', $loaderTag = 'routing.loader')`
	`31`	`+ public function __construct(string $resolverServiceId = 'routing.resolver', string $loaderTag = 'routing.loader')`
`32`	`32`	`{`
`33`	`33`	`$this->resolverServiceId = $resolverServiceId;`
`34`	`34`	`$this->loaderTag = $loaderTag;`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class MethodNotAllowedException extends \RuntimeException implements ExceptionIn`
`22`	`22`	`{`
`23`	`23`	`protected $allowedMethods = array();`
`24`	`24`
`25`		`- public function __construct(array $allowedMethods, $message = null, $code = 0, \Exception $previous = null)`
	`25`	`+ public function __construct(array $allowedMethods, string $message = null, int $code = 0, \Exception $previous = null)`
`26`	`26`	`{`
`27`	`27`	`$this->allowedMethods = array_map('strtoupper', $allowedMethods);`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -36,11 +36,9 @@ public function __destruct()`
`36`	`36`	`/**`
`37`	`37`	`* Sets the prefix to add to the path of all child routes.`
`38`	`38`	`*`
`39`		`- * @param string $prefix`
`40`		`- *`
`41`	`39`	`* @return $this`
`42`	`40`	`*/`
`43`		`- final public function prefix($prefix)`
	`41`	`+ final public function prefix(string $prefix)`
`44`	`42`	`{`
`45`	`43`	`$this->route->addPrefix($prefix);`
`46`	`44`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class RouteConfigurator`
`22`	`22`	`use Traits\AddTrait;`
`23`	`23`	`use Traits\RouteTrait;`
`24`	`24`
`25`		`- public function __construct(RouteCollection $collection, Route $route, $name = '')`
	`25`	`+ public function __construct(RouteCollection $collection, Route $route, string $name = '')`
`26`	`26`	`{`
`27`	`27`	`$this->collection = $collection;`
`28`	`28`	`$this->route = $route;`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class RoutingConfigurator`
`25`	`25`	`private $path;`
`26`	`26`	`private $file;`
`27`	`27`
`28`		`- public function __construct(RouteCollection $collection, PhpFileLoader $loader, $path, $file)`
	`28`	`+ public function __construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file)`
`29`	`29`	`{`
`30`	`30`	`$this->collection = $collection;`
`31`	`31`	`$this->loader = $loader;`
Original file line number	Diff line number	Diff line change
`@@ -60,11 +60,9 @@ final public function options(array $options)`
`60`	`60`	`/**`
`61`	`61`	`* Sets the condition.`
`62`	`62`	`*`
`63`		`- * @param string $condition`
`64`		`- *`
`65`	`63`	`* @return $this`
`66`	`64`	`*/`
`67`		`- final public function condition($condition)`
	`65`	`+ final public function condition(string $condition)`
`68`	`66`	`{`
`69`	`67`	`$this->route->setCondition($condition);`
`70`	`68`
`@@ -74,11 +72,9 @@ final public function condition($condition)`
`74`	`72`	`/**`
`75`	`73`	`* Sets the pattern for the host.`
`76`	`74`	`*`
`77`		`- * @param string $pattern`
`78`		`- *`
`79`	`75`	`* @return $this`
`80`	`76`	`*/`
`81`		`- final public function host($pattern)`
	`77`	`+ final public function host(string $pattern)`
`82`	`78`	`{`
`83`	`79`	`$this->route->setHost($pattern);`
`84`	`80`