Merge branch '2.x'

* 2.x:
  deprecate non string versions
  mark form related classes as internal
  mark remaining DI related classes as internal
  mark the routing related classes as internal

Author: xabbuh

DependencyInjection/Compiler/HandlerRegistryDecorationPass.php

@@ -26,6 +26,8 @@
  * have been resolved.
  *
  * @author Christian Flothmann <[email protected]>
+ *
+ * @internal since 2.8
  */
 class HandlerRegistryDecorationPass implements CompilerPassInterface
 {

DependencyInjection/FOSRestExtension.php

@@ -24,6 +24,9 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\Validator\Constraint;
 
+/**
+ * @internal since 2.8
+ */
 class FOSRestExtension extends Extension
 {
     /**

EventListener/VersionListener.php

@@ -12,6 +12,7 @@
 namespace FOS\RestBundle\EventListener;
 
 use FOS\RestBundle\FOSRestBundle;
+use FOS\RestBundle\Version\ChainVersionResolver;
 use FOS\RestBundle\Version\VersionResolverInterface;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 
@@ -41,12 +42,17 @@ public function onKernelRequest($event)
         }
 
         $version = $this->versionResolver->resolve($request);
-        if (false === $version && null !== $this->defaultVersion) {
+
+        if (!$this->versionResolver instanceof ChainVersionResolver && null !== $version && !is_string($version)) {
+            @trigger_error(sprintf('Not returning a string or null from %s::resolve() when implementing the %s is deprecated since FOSRestBundle 2.8.', get_class($this->versionResolver), VersionResolverInterface::class), E_USER_DEPRECATED);
+        }
+
+        if ((false === $version || null === $version) && null !== $this->defaultVersion) {
             $version = $this->defaultVersion;
         }
 
         // Return if nothing to do
-        if (false === $version) {
+        if (false === $version || null === $version) {
             return;
         }
 

Form/Extension/DisableCSRFExtension.php

@@ -21,6 +21,8 @@
  * Class DisableCSRFExtension.
  *
  * @author Grégoire Pineau
+ *
+ * @internal since 2.8
  */
 class DisableCSRFExtension extends AbstractTypeExtension
 {

Form/Transformer/EntityToIdObjectTransformer.php

@@ -19,6 +19,8 @@
  * Class EntityToIdObjectTransformer.
  *
  * @author Marc Juchli <[email protected]>
+ *
+ * @internal since 2.8
  */
 class EntityToIdObjectTransformer implements DataTransformerInterface
 {

Routing/Loader/DirectoryRouteLoader.php

@@ -20,6 +20,8 @@
  * Parse annotated controller classes from all files of a directory.
  *
  * @author Christian Flothmann <[email protected]>
+ *
+ * @internal since 2.8
  */
 class DirectoryRouteLoader extends Loader
 {

Routing/Loader/Reader/RestActionReader.php

@@ -29,6 +29,8 @@
  * REST controller actions reader.
  *
  * @author Konstantin Kudryashov <[email protected]>
+ *
+ * @internal since 2.8
  */
 class RestActionReader
 {

Routing/Loader/Reader/RestControllerReader.php

@@ -21,6 +21,8 @@
  * REST controller reader.
  *
  * @author Konstantin Kudryashov <[email protected]>
+ *
+ * @internal since 2.8
  */
 class RestControllerReader
 {

Routing/Loader/RestRouteLoader.php

@@ -21,6 +21,8 @@
  *
  * @author Konstantin Kudryashov <[email protected]>
  * @author Bulat Shakirzyanov <[email protected]>
+ *
+ * @internal since 2.8
  */
 class RestRouteLoader extends Loader
 {

Routing/Loader/RestRouteProcessor.php

@@ -20,6 +20,8 @@
  *
  * @author Donald Tyler <[email protected]>
  * @author Konstantin Kudryashov <[email protected]>
+ *
+ * @internal since 2.8
  */
 class RestRouteProcessor
 {

Routing/Loader/RestXmlCollectionLoader.php

@@ -21,6 +21,8 @@
  * RestXmlCollectionLoader XML file collections loader.
  *
  * @author Donald Tyler <[email protected]>
+ *
+ * @internal since 2.8
  */
 class RestXmlCollectionLoader extends XmlFileLoader
 {

Routing/Loader/RestYamlCollectionLoader.php

@@ -21,6 +21,8 @@
 
 /**
  * RestYamlCollectionLoader YAML file collections loader.
+ *
+ * @internal since 2.8
  */
 class RestYamlCollectionLoader extends YamlFileLoader
 {

Routing/RestRouteCollection.php

@@ -17,6 +17,8 @@
  * Restful route collection.
  *
  * @author Konstantin Kudryashov <[email protected]>
+ *
+ * @internal since 2.8
  */
 class RestRouteCollection extends RouteCollection
 {

UPGRADING-2.8.md

@@ -1,11 +1,26 @@
 Upgrading From 2.7 To 2.8
 =========================
 
+ * Deprecated returning anything other than `string` or `null` from `resolve()` when implementing
+   the `VersionResolverInterface`.
+
  * Passing version number as integers to `Context::setVersion()` is deprecated. Strings will be
    enforced as of 3.0.
 
  * The following classes are marked as `internal`:
 
+   * `FOS\RestBundle\DependencyInjection\Compiler\HandlerRegistryDecorationPass`
+   * `FOS\RestBundle\DependencyInjection\FOSRestExtension`
+   * `FOS\RestBundle\Form\Extension\DisableCSRFExtension`
+   * `FOS\RestBundle\Form\Transformer\EntityToIdObjectTransformer`
+   * `FOS\RestBundle\Routing\Loader\DirectoryRouteLoader`
+   * `FOS\RestBundle\Routing\Loader\Reader\RestActionReader`
+   * `FOS\RestBundle\Routing\Loader\Reader\RestControllerReader`
+   * `FOS\RestBundle\Routing\Loader\RestRouteLoader`
+   * `FOS\RestBundle\Routing\Loader\RestRouteProcessor`
+   * `FOS\RestBundle\Routing\Loader\RestXmlCollectionLoader`
+   * `FOS\RestBundle\Routing\Loader\RestYamlCollectionLoader`
+   * `FOS\RestBundle\Routing\RestRouteCollection`
    * `FOS\RestBundle\Serializer\Normalizer\ExceptionHandler`
    * `FOS\RestBundle\Serializer\Normalizer\ExceptionNormalizer`
    * `FOS\RestBundle\Serializer\Normalizer\FormErrorHandler`

Version/ChainVersionResolver.php

@@ -37,12 +37,17 @@ public function resolve(Request $request)
     {
         foreach ($this->resolvers as $resolver) {
             $version = $resolver->resolve($request);
-            if (false !== $version) {
+
+            if (null !== $version && !is_string($version)) {
+                @trigger_error(sprintf('Not returning a string or null from %s::resolve() when implementing the %s is deprecated since FOSRestBundle 2.8.', get_class($resolver), VersionResolverInterface::class), E_USER_DEPRECATED);
+            }
+
+            if (null !== $version && false !== $version) {
                 return $version;
             }
         }
 
-        return false;
+        return null;
     }
 
     public function addResolver(VersionResolverInterface $resolver)

Version/Resolver/HeaderVersionResolver.php

@@ -35,11 +35,9 @@ public function __construct($headerName)
     public function resolve(Request $request)
     {
         if (!$request->headers->has($this->headerName)) {
-            return false;
+            return null;
         }
 
-        $header = $request->headers->get($this->headerName);
-
-        return is_scalar($header) ? $header : strval($header);
+        return (string) $request->headers->get($this->headerName);
     }
 }

Version/Resolver/MediaTypeVersionResolver.php

@@ -35,9 +35,9 @@ public function __construct($regex)
     public function resolve(Request $request)
     {
         if (!$request->attributes->has('media_type') || false === preg_match($this->regex, $request->attributes->get('media_type'), $matches)) {
-            return false;
+            return null;
         }
 
-        return isset($matches['version']) ? $matches['version'] : false;
+        return isset($matches['version']) ? $matches['version'] : null;
     }
 }

Version/Resolver/QueryParameterVersionResolver.php

@@ -35,11 +35,9 @@ public function __construct($parameterName)
     public function resolve(Request $request)
     {
         if (!$request->query->has($this->parameterName)) {
-            return false;
+            return null;
         }
 
-        $parameter = $request->query->get($this->parameterName);
-
-        return is_scalar($parameter) ? $parameter : strval($parameter);
+        return (string) $request->query->get($this->parameterName);
     }
 }

Version/VersionResolverInterface.php

@@ -19,7 +19,7 @@
 interface VersionResolverInterface
 {
     /**
-     * @return scalar|false Current version or false if not resolved
+     * @return string|null Current version or false if not resolved
      */
     public function resolve(Request $request);
 }