cs fixes

HeahDude · Iltar van der Berg · commit cee5106960c3 · 2016-04-01T11:46:27.000+02:00
diff --git a/UPGRADE-3.1.md b/UPGRADE-3.1.md
@@ -66,11 +66,10 @@ HttpKernel
    deprecated and will be removed in Symfony 4.0. The inline fragment
    renderer should be used with object attributes.
 
- * The `ControllerResolver::getArguments()` method is deprecated and will be
-   removed in 4.0. If you have your own `ControllerResolverInterface`
-   implementation, you should replace this method by implementing the
-   `ArgumentResolverInterface` and injecting it in the `HttpKernel`, or using
-   the `ArgumentResolver` and injecting this in the `HttpKernel`.
+ * The `ControllerResolver::getArguments()` method has been deprecated and will
+   be removed in 4.0. If you have your own `ControllerResolverInterface`
+   implementation, you should inject either an `ArgumentResolverInterface`
+   instance or the new `ArgumentResolver` in the `HttpKernel`.
 
 Serializer
 ----------
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml
@@ -17,13 +17,13 @@
             <argument type="service" id="logger" on-invalid="ignore" />
         </service>
 
+        <service id="argument_metadata_factory" class="Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory" public="false" />
+
         <service id="argument_resolver" class="Symfony\Component\HttpKernel\Controller\ArgumentResolver" public="false">
             <argument type="service" id="argument_metadata_factory" />
             <argument type="collection" />
         </service>
 
-        <service id="argument_metadata_factory" class="Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory" public="false" />
-
         <service id="argument_value_resolver.argument_from_attribute" class="Symfony\Component\HttpKernel\Controller\ArgumentValueResolver\ArgumentFromAttributeResolver" public="false">
             <tag name="controller_argument.value_resolver" priority="100" />
         </service>
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -4,10 +4,12 @@ CHANGELOG
 3.1.0
 -----
  * deprecated passing objects as URI attributes to the ESI and SSI renderers
- * Added a `LegacyArgumentResolver` with `getArguments()` and the corresponding interface `ArgumentResolverInterface`
- * Deprecated `ControllerResolver::getArguments()`, which uses the `LegacyArgumentResolver` as BC layer by extending it
- * The `HttpKernel` now accepts an additional argument for an `ArgumentResolverInterface`
- * Added the `ArgumentResolver` which features an extension point to resolve arguments in a more dynamic way
+ * added `Symfony\Component\HttpKernel\Controller\LegacyArgumentResolver`
+ * deprecated `ControllerResolver::getArguments()`
+ * made `ControllerResolver` extend the `LegacyArgumentResolver` for BC
+ * added `Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface`
+ * added `Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface` as argument to `HttpKernel`
+ * added `Symfony\Component\HttpKernel\Controller\ArgumentResolver`
 
 3.0.0
 -----
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver.php
@@ -15,7 +15,7 @@
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactoryInterface;
 
 /**
- * Responsible for the resolving of arguments passed to an action.
+ * Responsible for resolving the arguments passed to an action.
  *
  * @author Iltar van der Berg <kjarli@gmail.com>
  */
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolverInterface.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolverInterface.php
@@ -14,7 +14,7 @@
 use Symfony\Component\HttpFoundation\Request;
 
 /**
- * An ArgumentResolverInterface implementation knows how to determine the
+ * An ArgumentResolverInterface instance knows how to determine the
  * arguments for a specific action.
  *
  * @author Fabien Potencier <fabien@symfony.com>
@@ -29,7 +29,7 @@ interface ArgumentResolverInterface
      *
      * @return array An array of arguments to pass to the controller
      *
-     * @throws \RuntimeException When value for argument given is not provided
+     * @throws \RuntimeException When no value could be provided for a required argument
      */
     public function getArguments(Request $request, $controller);
 }
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolver/ArgumentFromAttributeResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolver/ArgumentFromAttributeResolver.php
@@ -16,7 +16,7 @@
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
 
 /**
- * Grabs a non-variadic value from the request and returns it.
+ * Yields a non-variadic argument's value from the request attributes.
  *
  * @author Iltar van der Berg <kjarli@gmail.com>
  */
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolver/DefaultArgumentValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolver/DefaultArgumentValueResolver.php
@@ -16,7 +16,7 @@
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
 
 /**
- * Returns the default value defined in the action signature if present and no value has been given.
+ * Yields the default value defined in the action signature when no value has been given.
  *
  * @author Iltar van der Berg <kjarli@gmail.com>
  */
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolver/RequestResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolver/RequestResolver.php
@@ -16,7 +16,7 @@
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
 
 /**
- * Supports the same instance as the request object passed along.
+ * Yields the same instance as the request object passed along.
  *
  * @author Iltar van der Berg <kjarli@gmail.com>
  */
@@ -27,7 +27,7 @@ final class RequestResolver implements ArgumentValueResolverInterface
      */
     public function supports(Request $request, ArgumentMetadata $argument)
     {
-        return $argument->getType() === Request::class || is_subclass_of($request, $argument->getType());
+        return $argument->getType() === Request::class || is_subclass_of(Request::class, $argument->getType());
     }
 
     /**
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolver/VariadicArgumentValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolver/VariadicArgumentValueResolver.php
@@ -16,7 +16,7 @@
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
 
 /**
- * Grabs the variadic value from the request and returns it.
+ * Yields a variadic argument's values from the request attributes.
  *
  * @author Iltar van der Berg <kjarli@gmail.com>
  */
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolverInterface.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentValueResolverInterface.php
@@ -22,7 +22,7 @@
 interface ArgumentValueResolverInterface
 {
     /**
-     * Whether this resolver can resolve can resolve the value for the given ArgumentMetadata.
+     * Whether this resolver can resolve the value for the given ArgumentMetadata.
      *
      * @param Request          $request
      * @param ArgumentMetadata $argument
@@ -34,8 +34,6 @@ public function supports(Request $request, ArgumentMetadata $argument);
     /**
      * Yield the possible value(s).
      *
-     * An implementation must yield at least one value.
-     *
      * @param Request          $request
      * @param ArgumentMetadata $argument
      *
diff --git a/src/Symfony/Component/HttpKernel/Controller/ControllerResolver.php b/src/Symfony/Component/HttpKernel/Controller/ControllerResolver.php
@@ -85,7 +85,7 @@ public function getController(Request $request)
     /**
      * {@inheritdoc}
      *
-     * @deprecated this method is deprecated as of 3.1 and will be removed in 4.0. Implement the ArgumentResolverInterface or extend the LegacyArgumentResolver instead.
+     * @deprecated This method is deprecated as of 3.1 and will be removed in 4.0. Implement the ArgumentResolverInterface or extend the LegacyArgumentResolver instead.
      */
     public function getArguments(Request $request, $controller)
     {
@@ -95,7 +95,7 @@ public function getArguments(Request $request, $controller)
     }
 
     /**
-     * @deprecated this method is deprecated as of 3.1 and will be removed in 4.0. Implement the ArgumentResolverInterface or extend the LegacyArgumentResolver instead.
+     * @deprecated This method is deprecated as of 3.1 and will be removed in 4.0. Implement the ArgumentResolverInterface or extend the LegacyArgumentResolver instead.
      */
     protected function doGetArguments(Request $request, $controller, array $parameters)
     {
diff --git a/src/Symfony/Component/HttpKernel/Controller/LegacyArgumentResolver.php b/src/Symfony/Component/HttpKernel/Controller/LegacyArgumentResolver.php
@@ -27,7 +27,7 @@ class LegacyArgumentResolver implements ArgumentResolverInterface
      */
     public function getArguments(Request $request, $controller)
     {
-        // only trigger the deprecation notice if actually used, the ControllerResolver still extends this for BC reasons
+        // only trigger the deprecation notice if actually used, the ControllerResolver still extends it for BC
         @trigger_error(sprintf('The %s class is deprecated since 3.1 and will be removed in 4.0. Please use the %s instead.', __CLASS__, ArgumentResolver::class), E_USER_DEPRECATED);
 
         if (is_array($controller)) {
diff --git a/src/Symfony/Component/HttpKernel/Controller/TraceableControllerResolver.php b/src/Symfony/Component/HttpKernel/Controller/TraceableControllerResolver.php
@@ -38,7 +38,7 @@ public function __construct(ControllerResolverInterface $resolver, Stopwatch $st
         $this->stopwatch = $stopwatch;
         $this->argumentResolver = $argumentResolver;
 
-        // required for BC reasons
+        // BC
         if (null === $this->argumentResolver) {
             $this->argumentResolver = $resolver;
         }
diff --git a/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php b/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php
@@ -34,7 +34,7 @@ public function createArgumentMetadata($controller)
         }
 
         foreach ($reflection->getParameters() as $param) {
-            $arguments[] = new ArgumentMetadata($param->getName(), $this->getType($param), $this->isVariadic($param), $this->hasDefaulValue($param), $this->getDefaulValue($param));
+            $arguments[] = new ArgumentMetadata($param->getName(), $this->getType($param), $this->isVariadic($param), $this->hasDefaultValue($param), $this->getDefaultValue($param));
         }
 
         return $arguments;
@@ -59,7 +59,7 @@ private function isVariadic(\ReflectionParameter $parameter)
      *
      * @return bool
      */
-    private function hasDefaulValue(\ReflectionParameter $parameter)
+    private function hasDefaultValue(\ReflectionParameter $parameter)
     {
         return $parameter->isDefaultValueAvailable();
     }
@@ -71,9 +71,9 @@ private function hasDefaulValue(\ReflectionParameter $parameter)
      *
      * @return mixed|null
      */
-    private function getDefaulValue(\ReflectionParameter $parameter)
+    private function getDefaultValue(\ReflectionParameter $parameter)
     {
-        return $this->hasDefaulValue($parameter) ? $parameter->getDefaultValue() : null;
+        return $this->hasDefaultValue($parameter) ? $parameter->getDefaultValue() : null;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactoryInterface;`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * Responsible for the resolving of arguments passed to an action.`
	`18`	`+ * Responsible for resolving the arguments passed to an action.`
`19`	`19`	`*`
`20`	`20`	`* @author Iltar van der Berg <[email protected]>`
`21`	`21`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`use Symfony\Component\HttpFoundation\Request;`
`15`	`15`
`16`	`16`	`/**`
`17`		`- * An ArgumentResolverInterface implementation knows how to determine the`
	`17`	`+ * An ArgumentResolverInterface instance knows how to determine the`
`18`	`18`	`* arguments for a specific action.`
`19`	`19`	`*`
`20`	`20`	`* @author Fabien Potencier <[email protected]>`
`@@ -29,7 +29,7 @@ interface ArgumentResolverInterface`
`29`	`29`	`*`
`30`	`30`	`* @return array An array of arguments to pass to the controller`
`31`	`31`	`*`
`32`		`- * @throws \RuntimeException When value for argument given is not provided`
	`32`	`+ * @throws \RuntimeException When no value could be provided for a required argument`
`33`	`33`	`*/`
`34`	`34`	`public function getArguments(Request $request, $controller);`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Grabs a non-variadic value from the request and returns it.`
	`19`	`+ * Yields a non-variadic argument's value from the request attributes.`
`20`	`20`	`*`
`21`	`21`	`* @author Iltar van der Berg <[email protected]>`
`22`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`interface ArgumentValueResolverInterface`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`		`- * Whether this resolver can resolve can resolve the value for the given ArgumentMetadata.`
	`25`	`+ * Whether this resolver can resolve the value for the given ArgumentMetadata.`
`26`	`26`	`*`
`27`	`27`	`* @param Request $request`
`28`	`28`	`* @param ArgumentMetadata $argument`
`@@ -34,8 +34,6 @@ public function supports(Request $request, ArgumentMetadata $argument);`
`34`	`34`	`/**`
`35`	`35`	`* Yield the possible value(s).`
`36`	`36`	`*`
`37`		`- * An implementation must yield at least one value.`
`38`		`- *`
`39`	`37`	`* @param Request $request`
`40`	`38`	`* @param ArgumentMetadata $argument`
`41`	`39`	`*`