Apply fixes from StyleCI

dbu · StyleCIBot · commit 7155dcbc30b2 · 2016-11-30T16:21:42.000Z
diff --git a/Candidates/Candidates.php b/Candidates/Candidates.php
@@ -40,8 +40,8 @@ class Candidates implements CandidatesInterface
     protected $limit;
 
     /**
-     * @param array $locales The locales to support.
-     * @param int   $limit   A limit to apply to the candidates generated.
+     * @param array $locales The locales to support
+     * @param int   $limit   A limit to apply to the candidates generated
      */
     public function __construct(array $locales = array(), $limit = 20)
     {
@@ -52,7 +52,7 @@ public function __construct(array $locales = array(), $limit = 20)
     /**
      * Set the locales to support by this strategy.
      *
-     * @param array $locales The locales to support.
+     * @param array $locales The locales to support
      */
     public function setLocales(array $locales)
     {
@@ -97,9 +97,9 @@ public function getCandidates(Request $request)
     /**
      * Determine the locale of this URL.
      *
-     * @param string $url The url to determine the locale from.
+     * @param string $url The url to determine the locale from
      *
-     * @return string|bool The locale if $url starts with one of the allowed locales.
+     * @return string|bool The locale if $url starts with one of the allowed locales
      */
     protected function determineLocale($url)
     {
@@ -120,11 +120,11 @@ protected function determineLocale($url)
      *
      * $prefix is prepended to every candidate generated.
      *
-     * @param string $url    The URL to split.
-     * @param string $prefix A prefix to prepend to every pattern.
+     * @param string $url    The URL to split
+     * @param string $prefix A prefix to prepend to every pattern
      *
      * @return array Paths that could represent routes that match $url and are
-     *               child of $prefix.
+     *               child of $prefix
      */
     protected function getCandidatesFor($url, $prefix = '')
     {
diff --git a/Candidates/CandidatesInterface.php b/Candidates/CandidatesInterface.php
@@ -41,7 +41,7 @@ public function isCandidate($name);
      * Provide a best effort query restriction to limit a query to only find
      * routes that are supported.
      *
-     * @param object $queryBuilder A query builder suited for the storage backend.
+     * @param object $queryBuilder A query builder suited for the storage backend
      */
     public function restrictQuery($queryBuilder);
 }
diff --git a/ChainRouter.php b/ChainRouter.php
@@ -167,7 +167,7 @@ public function matchRequest(Request $request)
      *
      * @return array An array of parameters
      *
-     * @throws ResourceNotFoundException If no router matched.
+     * @throws ResourceNotFoundException If no router matched
      */
     private function doMatch($pathinfo, Request $request = null)
     {
diff --git a/ChainRouterInterface.php b/ChainRouterInterface.php
@@ -25,15 +25,15 @@ interface ChainRouterInterface extends RouterInterface, RequestMatcherInterface
      * Add a Router to the index.
      *
      * @param RouterInterface $router   The router instance. Instead of RouterInterface, may also
-     *                                  be RequestMatcherInterface and UrlGeneratorInterface.
+     *                                  be RequestMatcherInterface and UrlGeneratorInterface
      * @param int             $priority The priority
      */
     public function add($router, $priority = 0);
 
     /**
      * Sorts the routers and flattens them.
      *
-     * @return RouterInterface[] or RequestMatcherInterface and UrlGeneratorInterface.
+     * @return RouterInterface[] or RequestMatcherInterface and UrlGeneratorInterface
      */
     public function all();
 }
diff --git a/ContentAwareGenerator.php b/ContentAwareGenerator.php
@@ -58,11 +58,11 @@ public function setContentRepository(ContentRepositoryInterface $contentReposito
     /**
      * {@inheritdoc}
      *
-     * @param string $name       ignored.
+     * @param string $name       ignored
      * @param array  $parameters must either contain the field 'route' with a
      *                           RouteObjectInterface or the field 'content_id'
      *                           with the id of a document implementing
-     *                           RouteReferrersReadInterface.
+     *                           RouteReferrersReadInterface
      *
      * @throws RouteNotFoundException If there is no such route in the database
      */
@@ -228,7 +228,7 @@ protected function getRouteByLocale($routes, $locale)
      *
      * @return bool true if there is either no $locale, no _locale requirement
      *              on the route or if the requirement and the passed $locale
-     *              match.
+     *              match
      */
     private function checkLocaleRequirement(SymfonyRoute $route, $locale)
     {
@@ -245,7 +245,7 @@ private function checkLocaleRequirement(SymfonyRoute $route, $locale)
      *
      * @return string the locale following of the parameters or any other
      *                information the router has available. defaultLocale if no
-     *                other locale can be determined.
+     *                other locale can be determined
      */
     protected function getLocale($parameters)
     {
@@ -300,9 +300,9 @@ public function getRouteDebugMessage($name, array $parameters = array())
      * and it is the default locale, remove it from the parameters so that we
      * do not get an unneeded ?_locale= query string.
      *
-     * @param SymfonyRoute $route      The route being generated.
+     * @param SymfonyRoute $route      The route being generated
      * @param array        $parameters The parameters used, will be modified to
-     *                                 remove the _locale field if needed.
+     *                                 remove the _locale field if needed
      */
     protected function unsetLocaleIfNotNeeded(SymfonyRoute $route, array &$parameters)
     {
diff --git a/ContentRepositoryInterface.php b/ContentRepositoryInterface.php
@@ -30,7 +30,7 @@ interface ContentRepositoryInterface
      *
      * @param string $id id of the content object
      *
-     * @return object A content that matches this id.
+     * @return object A content that matches this id
      */
     public function findById($id);
 
diff --git a/Enhancer/ConditionalEnhancer.php b/Enhancer/ConditionalEnhancer.php
@@ -29,12 +29,12 @@ class ConditionalEnhancer implements RouteEnhancerInterface
      *
      * The enhancer has to implement RouteEnhancerInterface.
      *
-     * @var array Ordered list of 'matcher', 'enhancer' pairs.
+     * @var array Ordered list of 'matcher', 'enhancer' pairs
      */
     private $enhancerMap;
 
     /**
-     * @param array $enhancerMap Ordered list of 'matcher', 'enhancer' pairs.
+     * @param array $enhancerMap Ordered list of 'matcher', 'enhancer' pairs
      */
     public function __construct(array $enhancerMap)
     {
diff --git a/Enhancer/RouteEnhancerInterface.php b/Enhancer/RouteEnhancerInterface.php
@@ -27,11 +27,11 @@ interface RouteEnhancerInterface
     /**
      * Update the defaults based on its own data and the request.
      *
-     * @param array   $defaults the getRouteDefaults array.
-     * @param Request $request  the Request instance.
+     * @param array   $defaults the getRouteDefaults array
+     * @param Request $request  the Request instance
      *
      * @return array the modified defaults. Each enhancer MUST return the
-     *               $defaults but may add or remove values.
+     *               $defaults but may add or remove values
      */
     public function enhance(array $defaults, Request $request);
 }
diff --git a/NestedMatcher/FinalMatcherInterface.php b/NestedMatcher/FinalMatcherInterface.php
@@ -26,8 +26,8 @@ interface FinalMatcherInterface
     /**
      * Matches a request against a route collection and returns exactly one result.
      *
-     * @param RouteCollection $collection The collection against which to match.
-     * @param Request         $request    The request to match.
+     * @param RouteCollection $collection The collection against which to match
+     * @param Request         $request    The request to match
      *
      * @return array An array of parameters
      *
diff --git a/NestedMatcher/NestedMatcher.php b/NestedMatcher/NestedMatcher.php
@@ -83,7 +83,7 @@ public function __construct(
     /**
      * Sets the route provider for the matching plan.
      *
-     * @param RouteProviderInterface $provider A source of routes.
+     * @param RouteProviderInterface $provider A source of routes
      *
      * @return NestedMatcher this object to have a fluent interface
      */
@@ -102,7 +102,7 @@ public function setRouteProvider(RouteProviderInterface $provider)
      * @param RouteFilterInterface $filter
      * @param int                  $priority (optional) The priority of the
      *                                       filter. Higher number filters will
-     *                                       be used first. Defaults to 0.
+     *                                       be used first. Defaults to 0
      *
      * @return NestedMatcher this object to have a fluent interface
      */
@@ -122,7 +122,7 @@ public function addRouteFilter(RouteFilterInterface $filter, $priority = 0)
      * Sets the final matcher for the matching plan.
      *
      * @param FinalMatcherInterface $final The final matcher that will have to
-     *                                     pick the route that will be used.
+     *                                     pick the route that will be used
      *
      * @return NestedMatcher this object to have a fluent interface
      */
diff --git a/NestedMatcher/RouteFilterInterface.php b/NestedMatcher/RouteFilterInterface.php
@@ -31,16 +31,16 @@ interface RouteFilterInterface
      * Filters the route collection against a request and returns all matching
      * routes.
      *
-     * @param RouteCollection $collection The collection against which to match.
-     * @param Request         $request    A Request object against which to match.
+     * @param RouteCollection $collection The collection against which to match
+     * @param Request         $request    A Request object against which to match
      *
-     * @return RouteCollection A non-empty RouteCollection of matched routes.
+     * @return RouteCollection A non-empty RouteCollection of matched routes
      *
      * @throws ResourceNotFoundException if none of the routes in $collection
      *                                   matches $request. This is a performance
      *                                   optimization to not continue the match
      *                                   process when a match will no longer be
-     *                                   possible.
+     *                                   possible
      */
     public function filter(RouteCollection $collection, Request $request);
 }
diff --git a/PagedRouteCollection.php b/PagedRouteCollection.php
@@ -55,7 +55,7 @@ public function __construct(PagedRouteProviderInterface $pagedRouteProvider, $ro
     /**
      * Loads the next routes into the elements array.
      *
-     * @param int $offset The offset used in the db query.
+     * @param int $offset The offset used in the db query
      */
     protected function loadNextElements($offset)
     {
diff --git a/PagedRouteProviderInterface.php b/PagedRouteProviderInterface.php
@@ -40,13 +40,13 @@ interface PagedRouteProviderInterface extends RouteProviderInterface
      * all routes at once.
      *
      * @param int $offset
-     *                    The sequence will start with that offset in the list of all routes.
+     *                    The sequence will start with that offset in the list of all routes
      * @param int $length [optional]
      *                    The sequence will have that many routes in it. If no length is
-     *                    specified all routes are returned.
+     *                    specified all routes are returned
      *
      * @return \Symfony\Component\Routing\Route[]
-     *                                            Routes keyed by the route name.
+     *                                            Routes keyed by the route name
      */
     public function getRoutesPaged($offset, $length = null);
 
diff --git a/RouteProviderInterface.php b/RouteProviderInterface.php
@@ -41,17 +41,17 @@ interface RouteProviderInterface
      * very large route sets to be filtered down to likely candidates, which
      * may then be filtered in memory more completely.
      *
-     * @param Request $request A request against which to match.
+     * @param Request $request A request against which to match
      *
      * @return RouteCollection with all Routes that could potentially match
-     *                         $request. Empty collection if nothing can match.
+     *                         $request. Empty collection if nothing can match
      */
     public function getRouteCollectionForRequest(Request $request);
 
     /**
      * Find the route using the provided route name.
      *
-     * @param string $name The route name to fetch.
+     * @param string $name The route name to fetch
      *
      * @return Route
      *
@@ -79,10 +79,10 @@ public function getRouteByName($name);
      * DynamicRouter::getRouteCollection() call.
      *
      * @param array|null $names The list of names to retrieve, In case of null,
-     *                          the provider will determine what routes to return.
+     *                          the provider will determine what routes to return
      *
      * @return Route[] Iterable list with the keys being the names from the
-     *                 $names array.
+     *                 $names array
      */
     public function getRoutesByNames($names);
 }

Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,8 @@ class Candidates implements CandidatesInterface`
`40`	`40`	`protected $limit;`
`41`	`41`
`42`	`42`	`/**`
`43`		`- * @param array $locales The locales to support.`
`44`		`- * @param int $limit A limit to apply to the candidates generated.`
	`43`	`+ * @param array $locales The locales to support`
	`44`	`+ * @param int $limit A limit to apply to the candidates generated`
`45`	`45`	`*/`
`46`	`46`	`public function __construct(array $locales = array(), $limit = 20)`
`47`	`47`	`{`
`@@ -52,7 +52,7 @@ public function __construct(array $locales = array(), $limit = 20)`
`52`	`52`	`/**`
`53`	`53`	`* Set the locales to support by this strategy.`
`54`	`54`	`*`
`55`		`- * @param array $locales The locales to support.`
	`55`	`+ * @param array $locales The locales to support`
`56`	`56`	`*/`
`57`	`57`	`public function setLocales(array $locales)`
`58`	`58`	`{`
`@@ -97,9 +97,9 @@ public function getCandidates(Request $request)`
`97`	`97`	`/**`
`98`	`98`	`* Determine the locale of this URL.`
`99`	`99`	`*`
`100`		`- * @param string $url The url to determine the locale from.`
	`100`	`+ * @param string $url The url to determine the locale from`
`101`	`101`	`*`
`102`		`- * @return string\|bool The locale if $url starts with one of the allowed locales.`
	`102`	`+ * @return string\|bool The locale if $url starts with one of the allowed locales`
`103`	`103`	`*/`
`104`	`104`	`protected function determineLocale($url)`
`105`	`105`	`{`
`@@ -120,11 +120,11 @@ protected function determineLocale($url)`
`120`	`120`	`*`
`121`	`121`	`* $prefix is prepended to every candidate generated.`
`122`	`122`	`*`
`123`		`- * @param string $url The URL to split.`
`124`		`- * @param string $prefix A prefix to prepend to every pattern.`
	`123`	`+ * @param string $url The URL to split`
	`124`	`+ * @param string $prefix A prefix to prepend to every pattern`
`125`	`125`	`*`
`126`	`126`	`* @return array Paths that could represent routes that match $url and are`
`127`		`- * child of $prefix.`
	`127`	`+ * child of $prefix`
`128`	`128`	`*/`
`129`	`129`	`protected function getCandidatesFor($url, $prefix = '')`
`130`	`130`	`{`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function isCandidate($name);`
`41`	`41`	`* Provide a best effort query restriction to limit a query to only find`
`42`	`42`	`* routes that are supported.`
`43`	`43`	`*`
`44`		`- * @param object $queryBuilder A query builder suited for the storage backend.`
	`44`	`+ * @param object $queryBuilder A query builder suited for the storage backend`
`45`	`45`	`*/`
`46`	`46`	`public function restrictQuery($queryBuilder);`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -167,7 +167,7 @@ public function matchRequest(Request $request)`
`167`	`167`	`*`
`168`	`168`	`* @return array An array of parameters`
`169`	`169`	`*`
`170`		`- * @throws ResourceNotFoundException If no router matched.`
	`170`	`+ * @throws ResourceNotFoundException If no router matched`
`171`	`171`	`*/`
`172`	`172`	`private function doMatch($pathinfo, Request $request = null)`
`173`	`173`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,15 +25,15 @@ interface ChainRouterInterface extends RouterInterface, RequestMatcherInterface`
`25`	`25`	`* Add a Router to the index.`
`26`	`26`	`*`
`27`	`27`	`* @param RouterInterface $router The router instance. Instead of RouterInterface, may also`
`28`		`- * be RequestMatcherInterface and UrlGeneratorInterface.`
	`28`	`+ * be RequestMatcherInterface and UrlGeneratorInterface`
`29`	`29`	`* @param int $priority The priority`
`30`	`30`	`*/`
`31`	`31`	`public function add($router, $priority = 0);`
`32`	`32`
`33`	`33`	`/**`
`34`	`34`	`* Sorts the routers and flattens them.`
`35`	`35`	`*`
`36`		`- * @return RouterInterface[] or RequestMatcherInterface and UrlGeneratorInterface.`
	`36`	`+ * @return RouterInterface[] or RequestMatcherInterface and UrlGeneratorInterface`
`37`	`37`	`*/`
`38`	`38`	`public function all();`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,11 +58,11 @@ public function setContentRepository(ContentRepositoryInterface $contentReposito`
`58`	`58`	`/**`
`59`	`59`	`* {@inheritdoc}`
`60`	`60`	`*`
`61`		`- * @param string $name ignored.`
	`61`	`+ * @param string $name ignored`
`62`	`62`	`* @param array $parameters must either contain the field 'route' with a`
`63`	`63`	`* RouteObjectInterface or the field 'content_id'`
`64`	`64`	`* with the id of a document implementing`
`65`		`- * RouteReferrersReadInterface.`
	`65`	`+ * RouteReferrersReadInterface`
`66`	`66`	`*`
`67`	`67`	`* @throws RouteNotFoundException If there is no such route in the database`
`68`	`68`	`*/`
`@@ -228,7 +228,7 @@ protected function getRouteByLocale($routes, $locale)`
`228`	`228`	`*`
`229`	`229`	`* @return bool true if there is either no $locale, no _locale requirement`
`230`	`230`	`* on the route or if the requirement and the passed $locale`
`231`		`- * match.`
	`231`	`+ * match`
`232`	`232`	`*/`
`233`	`233`	`private function checkLocaleRequirement(SymfonyRoute $route, $locale)`
`234`	`234`	`{`
`@@ -245,7 +245,7 @@ private function checkLocaleRequirement(SymfonyRoute $route, $locale)`
`245`	`245`	`*`
`246`	`246`	`* @return string the locale following of the parameters or any other`
`247`	`247`	`* information the router has available. defaultLocale if no`
`248`		`- * other locale can be determined.`
	`248`	`+ * other locale can be determined`
`249`	`249`	`*/`
`250`	`250`	`protected function getLocale($parameters)`
`251`	`251`	`{`
`@@ -300,9 +300,9 @@ public function getRouteDebugMessage($name, array $parameters = array())`
`300`	`300`	`* and it is the default locale, remove it from the parameters so that we`
`301`	`301`	`* do not get an unneeded ?_locale= query string.`
`302`	`302`	`*`
`303`		`- * @param SymfonyRoute $route The route being generated.`
	`303`	`+ * @param SymfonyRoute $route The route being generated`
`304`	`304`	`* @param array $parameters The parameters used, will be modified to`
`305`		`- * remove the _locale field if needed.`
	`305`	`+ * remove the _locale field if needed`
`306`	`306`	`*/`
`307`	`307`	`protected function unsetLocaleIfNotNeeded(SymfonyRoute $route, array &$parameters)`
`308`	`308`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ interface ContentRepositoryInterface`
`30`	`30`	`*`
`31`	`31`	`* @param string $id id of the content object`
`32`	`32`	`*`
`33`		`- * @return object A content that matches this id.`
	`33`	`+ * @return object A content that matches this id`
`34`	`34`	`*/`
`35`	`35`	`public function findById($id);`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -29,12 +29,12 @@ class ConditionalEnhancer implements RouteEnhancerInterface`
`29`	`29`	`*`
`30`	`30`	`* The enhancer has to implement RouteEnhancerInterface.`
`31`	`31`	`*`
`32`		`- * @var array Ordered list of 'matcher', 'enhancer' pairs.`
	`32`	`+ * @var array Ordered list of 'matcher', 'enhancer' pairs`
`33`	`33`	`*/`
`34`	`34`	`private $enhancerMap;`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * @param array $enhancerMap Ordered list of 'matcher', 'enhancer' pairs.`
	`37`	`+ * @param array $enhancerMap Ordered list of 'matcher', 'enhancer' pairs`
`38`	`38`	`*/`
`39`	`39`	`public function __construct(array $enhancerMap)`
`40`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,11 @@ interface RouteEnhancerInterface`
`27`	`27`	`/**`
`28`	`28`	`* Update the defaults based on its own data and the request.`
`29`	`29`	`*`
`30`		`- * @param array $defaults the getRouteDefaults array.`
`31`		`- * @param Request $request the Request instance.`
	`30`	`+ * @param array $defaults the getRouteDefaults array`
	`31`	`+ * @param Request $request the Request instance`
`32`	`32`	`*`
`33`	`33`	`* @return array the modified defaults. Each enhancer MUST return the`
`34`		`- * $defaults but may add or remove values.`
	`34`	`+ * $defaults but may add or remove values`
`35`	`35`	`*/`
`36`	`36`	`public function enhance(array $defaults, Request $request);`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,8 @@ interface FinalMatcherInterface`
`26`	`26`	`/**`
`27`	`27`	`* Matches a request against a route collection and returns exactly one result.`
`28`	`28`	`*`
`29`		`- * @param RouteCollection $collection The collection against which to match.`
`30`		`- * @param Request $request The request to match.`
	`29`	`+ * @param RouteCollection $collection The collection against which to match`
	`30`	`+ * @param Request $request The request to match`
`31`	`31`	`*`
`32`	`32`	`* @return array An array of parameters`
`33`	`33`	`*`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public function __construct(`
`83`	`83`	`/**`
`84`	`84`	`* Sets the route provider for the matching plan.`
`85`	`85`	`*`
`86`		`- * @param RouteProviderInterface $provider A source of routes.`
	`86`	`+ * @param RouteProviderInterface $provider A source of routes`
`87`	`87`	`*`
`88`	`88`	`* @return NestedMatcher this object to have a fluent interface`
`89`	`89`	`*/`
`@@ -102,7 +102,7 @@ public function setRouteProvider(RouteProviderInterface $provider)`
`102`	`102`	`* @param RouteFilterInterface $filter`
`103`	`103`	`* @param int $priority (optional) The priority of the`
`104`	`104`	`* filter. Higher number filters will`
`105`		`- * be used first. Defaults to 0.`
	`105`	`+ * be used first. Defaults to 0`
`106`	`106`	`*`
`107`	`107`	`* @return NestedMatcher this object to have a fluent interface`
`108`	`108`	`*/`
`@@ -122,7 +122,7 @@ public function addRouteFilter(RouteFilterInterface $filter, $priority = 0)`
`122`	`122`	`* Sets the final matcher for the matching plan.`
`123`	`123`	`*`
`124`	`124`	`* @param FinalMatcherInterface $final The final matcher that will have to`
`125`		`- * pick the route that will be used.`
	`125`	`+ * pick the route that will be used`
`126`	`126`	`*`
`127`	`127`	`* @return NestedMatcher this object to have a fluent interface`
`128`	`128`	`*/`