Merge pull request #574 from merk/view-redirections

Change how redirections are created

Author: lsmith77

UPGRADING.md

@@ -4,6 +4,12 @@ Upgrading
 Note as FOSRestBundle is not yet declared stable, this document will be updated to
 list important BC breaks.
 
+### upgrading to 2.0.0 (unreleased)
+
+ * RedirectView and RouteRedirect view were removed. Use View::createRedirect and
+   View::createRouteRedirect instead. Note: the default status code for a route redirect
+   has changed from HTTP_CREATED (201) to HTTP_FOUND (302).
+
 ### upgrading from 0.13.1
 
  * ExceptionController::showAction() doesn't have type hint on the $exception object anymore due to a BC change

View/RedirectView.php

@@ -27,9 +27,11 @@ class RedirectView
      * @param string  $url
      * @param integer $statusCode
      * @param array   $headers
+     *
+     * @deprecated To be removed in FOSRestBundle 2.0.0. Use View::createRedirect instead.
      */
     public static function create($url, $statusCode = Codes::HTTP_FOUND, array $headers = array())
     {
-        return View::create(null, $statusCode, $headers)->setLocation($url);
+        return View::createRedirect($url, $statusCode, $headers);
     }
 }

View/RouteRedirectView.php

@@ -28,9 +28,11 @@ class RouteRedirectView
      * @param mixed   $parameters
      * @param integer $statusCode
      * @param array   $headers
+     *
+     * @deprecated To be removed in FOSRestBundle 2.0.0. Use View::createRouteRedirect instead.
      */
     public static function create($route, array $parameters = array(), $statusCode = Codes::HTTP_CREATED, array $headers = array())
     {
-        return View::create(null, $statusCode, $headers)->setRoute($route)->setRouteParameters($parameters);
+        return View::createRouteRedirect($route, $parameters, $statusCode, $headers);
     }
 }

View/View.php

@@ -11,6 +11,7 @@
 
 namespace FOS\RestBundle\View;
 
+use FOS\Rest\Util\Codes;
 use Symfony\Bundle\FrameworkBundle\Templating\TemplateReference;
 use Symfony\Component\HttpFoundation\Response;
 
@@ -87,6 +88,46 @@ public static function create($data = null, $statusCode = null, array $headers =
         return new static($data, $statusCode, $headers);
     }
 
+    /**
+     * Convenience method to allow for a fluent interface while creating a redirect to a
+     * given url.
+     *
+     * @param string $url
+     * @param int $statusCode
+     * @param array $headers
+     * @return View
+     */
+    public static function createRedirect($url, $statusCode = Codes::HTTP_FOUND, array $headers = array())
+    {
+        $view = static::create(null, $statusCode, $headers);
+        $view->setLocation($url);
+
+        return $view;
+    }
+
+    /**
+     * Convenience method to allow for a fluent interface while creating a redirect to a
+     * given route.
+     *
+     * @param string $route
+     * @param array $parameters
+     * @param int $statusCode
+     * @param array $headers
+     * @return View
+     */
+    public static function createRouteRedirect(
+        $route,
+        array $parameters = array(),
+        $statusCode = Codes::HTTP_FOUND,
+        array $headers = array()
+    ) {
+        $view = static::create(null, $statusCode, $headers);
+        $view->setRoute($route);
+        $view->setRouteParameters($parameters);
+
+        return $view;
+    }
+
     /**
      * Constructor
      *