Merge branch '2.7' into 2.8

nicolas-grekas · nicolas-grekas · commit e6738f7addd9 · 2017-10-24T15:48:52.000+02:00
* 2.7:
  [DI] minor docblock fixes
diff --git a/Exception/MethodNotAllowedException.php b/Exception/MethodNotAllowedException.php
@@ -20,9 +20,6 @@
  */
 class MethodNotAllowedException extends \RuntimeException implements ExceptionInterface
 {
-    /**
-     * @var array
-     */
     protected $allowedMethods = array();
 
     public function __construct(array $allowedMethods, $message = null, $code = 0, \Exception $previous = null)
diff --git a/Generator/Dumper/GeneratorDumper.php b/Generator/Dumper/GeneratorDumper.php
@@ -20,14 +20,8 @@
  */
 abstract class GeneratorDumper implements GeneratorDumperInterface
 {
-    /**
-     * @var RouteCollection
-     */
     private $routes;
 
-    /**
-     * @param RouteCollection $routes The RouteCollection to dump
-     */
     public function __construct(RouteCollection $routes)
     {
         $this->routes = $routes;
diff --git a/Generator/UrlGenerator.php b/Generator/UrlGenerator.php
@@ -27,24 +27,14 @@
  */
 class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInterface
 {
-    /**
-     * @var RouteCollection
-     */
     protected $routes;
-
-    /**
-     * @var RequestContext
-     */
     protected $context;
 
     /**
      * @var bool|null
      */
     protected $strictRequirements = true;
 
-    /**
-     * @var LoggerInterface|null
-     */
     protected $logger;
 
     /**
@@ -75,11 +65,6 @@ class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInt
         '%7C' => '|',
     );
 
-    /**
-     * @param RouteCollection      $routes  A RouteCollection instance
-     * @param RequestContext       $context The context
-     * @param LoggerInterface|null $logger  A logger instance
-     */
     public function __construct(RouteCollection $routes, RequestContext $context, LoggerInterface $logger = null)
     {
         $this->routes = $routes;
diff --git a/Loader/AnnotationClassLoader.php b/Loader/AnnotationClassLoader.php
@@ -57,9 +57,6 @@
  */
 abstract class AnnotationClassLoader implements LoaderInterface
 {
-    /**
-     * @var Reader
-     */
     protected $reader;
 
     /**
@@ -72,9 +69,6 @@ abstract class AnnotationClassLoader implements LoaderInterface
      */
     protected $defaultRouteIndex = 0;
 
-    /**
-     * @param Reader $reader
-     */
     public function __construct(Reader $reader)
     {
         $this->reader = $reader;
diff --git a/Loader/AnnotationFileLoader.php b/Loader/AnnotationFileLoader.php
@@ -27,9 +27,6 @@ class AnnotationFileLoader extends FileLoader
     protected $loader;
 
     /**
-     * @param FileLocatorInterface  $locator A FileLocator instance
-     * @param AnnotationClassLoader $loader  An AnnotationClassLoader instance
-     *
      * @throws \RuntimeException
      */
     public function __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)
diff --git a/Matcher/Dumper/ApacheMatcherDumper.php b/Matcher/Dumper/ApacheMatcherDumper.php
@@ -35,8 +35,6 @@ class ApacheMatcherDumper extends MatcherDumper
      *  * script_name: The script name (app.php by default)
      *  * base_uri:    The base URI ("" by default)
      *
-     * @param array $options An array of options
-     *
      * @return string A string to be used as Apache rewrite rules
      *
      * @throws \LogicException When the route regex is invalid
@@ -191,8 +189,6 @@ private function dumpRoute($name, $route, array $options, $hostRegexUnique)
     /**
      * Returns methods allowed for a route.
      *
-     * @param Route $route The route
-     *
      * @return array The methods
      */
     private function getRouteMethods(Route $route)
@@ -256,8 +252,6 @@ private static function escape($string, $char, $with)
     /**
      * Normalizes an array of values.
      *
-     * @param array $values
-     *
      * @return string[]
      */
     private function normalizeValues(array $values)
diff --git a/Matcher/Dumper/DumperCollection.php b/Matcher/Dumper/DumperCollection.php
@@ -105,8 +105,6 @@ protected function getParent()
 
     /**
      * Sets the parent collection.
-     *
-     * @param DumperCollection $parent The parent collection
      */
     protected function setParent(DumperCollection $parent)
     {
diff --git a/Matcher/Dumper/DumperPrefixCollection.php b/Matcher/Dumper/DumperPrefixCollection.php
@@ -48,8 +48,6 @@ public function setPrefix($prefix)
     /**
      * Adds a route in the tree.
      *
-     * @param DumperRoute $route The route
-     *
      * @return self
      *
      * @throws \LogicException
diff --git a/Matcher/Dumper/MatcherDumper.php b/Matcher/Dumper/MatcherDumper.php
@@ -20,14 +20,8 @@
  */
 abstract class MatcherDumper implements MatcherDumperInterface
 {
-    /**
-     * @var RouteCollection
-     */
     private $routes;
 
-    /**
-     * @param RouteCollection $routes The RouteCollection to dump
-     */
     public function __construct(RouteCollection $routes)
     {
         $this->routes = $routes;
diff --git a/Matcher/Dumper/PhpMatcherDumper.php b/Matcher/Dumper/PhpMatcherDumper.php
@@ -372,8 +372,6 @@ private function groupRoutesByHostRegex(RouteCollection $routes)
      * Routes order is preserved such that traversing the tree will traverse the
      * routes in the origin order.
      *
-     * @param DumperCollection $collection A collection of routes
-     *
      * @return DumperPrefixCollection
      */
     private function buildPrefixTree(DumperCollection $collection)
diff --git a/Matcher/RequestMatcherInterface.php b/Matcher/RequestMatcherInterface.php
@@ -28,8 +28,6 @@ interface RequestMatcherInterface
      * If the matcher can not find information, it must throw one of the exceptions documented
      * below.
      *
-     * @param Request $request The request to match
-     *
      * @return array An array of parameters
      *
      * @throws ResourceNotFoundException If no matching resource could be found
diff --git a/Matcher/UrlMatcher.php b/Matcher/UrlMatcher.php
@@ -31,21 +31,9 @@ class UrlMatcher implements UrlMatcherInterface, RequestMatcherInterface
     const REQUIREMENT_MISMATCH = 1;
     const ROUTE_MATCH = 2;
 
-    /**
-     * @var RequestContext
-     */
     protected $context;
-
-    /**
-     * @var array
-     */
     protected $allow = array();
-
-    /**
-     * @var RouteCollection
-     */
     protected $routes;
-
     protected $request;
     protected $expressionLanguage;
 
@@ -54,10 +42,6 @@ class UrlMatcher implements UrlMatcherInterface, RequestMatcherInterface
      */
     protected $expressionLanguageProviders = array();
 
-    /**
-     * @param RouteCollection $routes  A RouteCollection instance
-     * @param RequestContext  $context The context
-     */
     public function __construct(RouteCollection $routes, RequestContext $context)
     {
         $this->routes = $routes;
diff --git a/RequestContext.php b/RequestContext.php
@@ -31,10 +31,6 @@ class RequestContext
     private $httpPort;
     private $httpsPort;
     private $queryString;
-
-    /**
-     * @var array
-     */
     private $parameters = array();
 
     /**
@@ -62,8 +58,6 @@ public function __construct($baseUrl = '', $method = 'GET', $host = 'localhost',
     /**
      * Updates the RequestContext information based on a HttpFoundation Request.
      *
-     * @param Request $request A Request instance
-     *
      * @return $this
      */
     public function fromRequest(Request $request)
diff --git a/RequestContextAwareInterface.php b/RequestContextAwareInterface.php
@@ -15,8 +15,6 @@ interface RequestContextAwareInterface
 {
     /**
      * Sets the request context.
-     *
-     * @param RequestContext $context The context
      */
     public function setContext(RequestContext $context);
 
diff --git a/Route.php b/Route.php
@@ -19,51 +19,20 @@
  */
 class Route implements \Serializable
 {
-    /**
-     * @var string
-     */
     private $path = '/';
-
-    /**
-     * @var string
-     */
     private $host = '';
-
-    /**
-     * @var string[]
-     */
     private $schemes = array();
-
-    /**
-     * @var string[]
-     */
     private $methods = array();
-
-    /**
-     * @var array
-     */
     private $defaults = array();
-
-    /**
-     * @var array
-     */
     private $requirements = array();
-
-    /**
-     * @var array
-     */
     private $options = array();
+    private $condition = '';
 
     /**
      * @var null|CompiledRoute
      */
     private $compiled;
 
-    /**
-     * @var string
-     */
-    private $condition = '';
-
     /**
      * Available options:
      *
diff --git a/RouteCollection.php b/RouteCollection.php
@@ -116,8 +116,6 @@ public function remove($name)
     /**
      * Adds a route collection at the end of the current set by appending all
      * routes of the added collection.
-     *
-     * @param RouteCollection $collection A RouteCollection instance
      */
     public function addCollection(RouteCollection $collection)
     {
@@ -267,8 +265,6 @@ public function getResources()
 
     /**
      * Adds a resource for this collection.
-     *
-     * @param ResourceInterface $resource A resource instance
      */
     public function addResource(ResourceInterface $resource)
     {
diff --git a/RouteCompilerInterface.php b/RouteCompilerInterface.php
@@ -21,8 +21,6 @@ interface RouteCompilerInterface
     /**
      * Compiles the current route instance.
      *
-     * @param Route $route A Route instance
-     *
      * @return CompiledRoute A CompiledRoute instance
      *
      * @throws \LogicException If the Route cannot be compiled because the
diff --git a/Router.php b/Router.php
@@ -226,8 +226,6 @@ public function getContext()
 
     /**
      * Sets the ConfigCache factory to use.
-     *
-     * @param ConfigCacheFactoryInterface $configCacheFactory The factory to use
      */
     public function setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)
     {

Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,6 @@`
`20`	`20`	`*/`
`21`	`21`	`class MethodNotAllowedException extends \RuntimeException implements ExceptionInterface`
`22`	`22`	`{`
`23`		`- /**`
`24`		`- * @var array`
`25`		`- */`
`26`	`23`	`protected $allowedMethods = array();`
`27`	`24`
`28`	`25`	`public function __construct(array $allowedMethods, $message = null, $code = 0, \Exception $previous = null)`
Original file line number	Diff line number	Diff line change
`@@ -20,14 +20,8 @@`
`20`	`20`	`*/`
`21`	`21`	`abstract class GeneratorDumper implements GeneratorDumperInterface`
`22`	`22`	`{`
`23`		`- /**`
`24`		`- * @var RouteCollection`
`25`		`- */`
`26`	`23`	`private $routes;`
`27`	`24`
`28`		`- /**`
`29`		`- * @param RouteCollection $routes The RouteCollection to dump`
`30`		`- */`
`31`	`25`	`public function __construct(RouteCollection $routes)`
`32`	`26`	`{`
`33`	`27`	`$this->routes = $routes;`
Original file line number	Diff line number	Diff line change
`@@ -105,8 +105,6 @@ protected function getParent()`
`105`	`105`
`106`	`106`	`/**`
`107`	`107`	`* Sets the parent collection.`
`108`		`- *`
`109`		`- * @param DumperCollection $parent The parent collection`
`110`	`108`	`*/`
`111`	`109`	`protected function setParent(DumperCollection $parent)`
`112`	`110`	`{`
Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,6 @@ public function setPrefix($prefix)`
`48`	`48`	`/**`
`49`	`49`	`* Adds a route in the tree.`
`50`	`50`	`*`
`51`		`- * @param DumperRoute $route The route`
`52`		`- *`
`53`	`51`	`* @return self`
`54`	`52`	`*`
`55`	`53`	`* @throws \LogicException`
Original file line number	Diff line number	Diff line change
`@@ -372,8 +372,6 @@ private function groupRoutesByHostRegex(RouteCollection $routes)`
`372`	`372`	`* Routes order is preserved such that traversing the tree will traverse the`
`373`	`373`	`* routes in the origin order.`
`374`	`374`	`*`
`375`		`- * @param DumperCollection $collection A collection of routes`
`376`		`- *`
`377`	`375`	`* @return DumperPrefixCollection`
`378`	`376`	`*/`
`379`	`377`	`private function buildPrefixTree(DumperCollection $collection)`