Add morphing and morphed callbacks so users can have a finer control of how responses are morphed.

Signed-off-by: Jason Lewis <[email protected]>

Author: jasonlewis

src/Http/Response.php

@@ -2,6 +2,7 @@
 
 namespace Dingo\Api\Http;
 
+use Closure;
 use ArrayObject;
 use UnexpectedValueException;
 use Dingo\Api\Transformer\Binding;
@@ -36,6 +37,20 @@ class Response extends IlluminateResponse
      */
     protected static $transformer;
 
+    /**
+     * Array of user-defined morphing callbacks.
+     *
+     * @var array
+     */
+    protected static $morphingCallbacks = [];
+
+    /**
+     * Array of user-defined morphed callbacks.
+     *
+     * @var array
+     */
+    protected static $morphedCallbacks = [];
+
     /**
      * Create a new response instance.
      *
@@ -78,10 +93,12 @@ public static function makeFromExisting(IlluminateResponse $old)
      */
     public function morph($format = 'json')
     {
-        $content = $this->getOriginalContent();
+        $this->content = $this->getOriginalContent();
 
-        if (isset(static::$transformer) && static::$transformer->transformableResponse($content)) {
-            $content = static::$transformer->transform($content);
+        $this->fireMorphingCallbacks();
+
+        if (isset(static::$transformer) && static::$transformer->transformableResponse($this->content)) {
+            $this->content = static::$transformer->transform($this->content);
         }
 
         $formatter = static::getFormatter($format);
@@ -90,21 +107,57 @@ public function morph($format = 'json')
 
         $this->headers->set('content-type', $formatter->getContentType());
 
-        if ($content instanceof EloquentModel) {
-            $content = $formatter->formatEloquentModel($content);
-        } elseif ($content instanceof EloquentCollection) {
-            $content = $formatter->formatEloquentCollection($content);
-        } elseif (is_array($content) || $content instanceof ArrayObject || $content instanceof Arrayable) {
-            $content = $formatter->formatArray($content);
+        $this->fireMorphedCallbacks();
+
+        if ($this->content instanceof EloquentModel) {
+            $this->content = $formatter->formatEloquentModel($this->content);
+        } elseif ($this->content instanceof EloquentCollection) {
+            $this->content = $formatter->formatEloquentCollection($this->content);
+        } elseif (is_array($this->content) || $this->content instanceof ArrayObject || $this->content instanceof Arrayable) {
+            $this->content = $formatter->formatArray($this->content);
         } else {
             $this->headers->set('content-type', $defaultContentType);
         }
 
-        $this->content = $content;
-
         return $this;
     }
 
+    /**
+     * Fire the morphed callbacks.
+     *
+     * @return void
+     */
+    protected function fireMorphedCallbacks()
+    {
+        $this->fireCallbacks(static::$morphedCallbacks);
+    }
+
+    /**
+     * Fire the morphing callbacks.
+     *
+     * @return void
+     */
+    protected function fireMorphingCallbacks()
+    {
+        $this->fireCallbacks(static::$morphingCallbacks);
+    }
+
+    /**
+     * Fire the callbacks with the content and response instance as parameters.
+     *
+     * @param array $callbacks
+     *
+     * @return void
+     */
+    protected function fireCallbacks(array $callbacks)
+    {
+        foreach ($callbacks as $callback) {
+            if ($response = call_user_func($callback, $this->content, $this)) {
+                $this->content = $response;
+            }
+        }
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -123,6 +176,30 @@ public function setContent($content)
         }
     }
 
+    /**
+     * Add a callback for when the response is about to be morphed.
+     *
+     * @param \Closure $callback
+     *
+     * @return void
+     */
+    public static function morphing(Closure $callback)
+    {
+        static::$morphingCallbacks[] = $callback;
+    }
+
+    /**
+     * Add a callback for when the response has been morphed.
+     *
+     * @param \Closure $callback
+     *
+     * @return void
+     */
+    public static function morphed(Closure $callback)
+    {
+        static::$morphedCallbacks[] = $callback;
+    }
+
     /**
      * Get the formatter based on the requested format type.
      *

tests/Http/ResponseTest.php

@@ -4,15 +4,29 @@
 
 use StdClass;
 use Mockery as m;
+use ReflectionClass;
 use Dingo\Api\Http\Response;
 use PHPUnit_Framework_TestCase;
 use Dingo\Api\Transformer\Binding;
+use Dingo\Api\Http\Response\Format\Json;
 
 class ResponseTest extends PHPUnit_Framework_TestCase
 {
     public function tearDown()
     {
         m::close();
+
+        $reflection = new ReflectionClass('Dingo\Api\Http\Response');
+
+        $property = $reflection->getProperty('morphedCallbacks');
+
+        $property->setAccessible(true);
+        $property->setValue([]);
+
+        $property = $reflection->getProperty('morphingCallbacks');
+
+        $property->setAccessible(true);
+        $property->setValue([]);
     }
 
     /**
@@ -55,4 +69,32 @@ public function testBuildingWithCustomStatusCodeAndHeaders()
         $this->assertEquals('Bar', $response->headers->get('Foo'));
         $this->assertEquals(302, $response->getStatusCode());
     }
+
+    public function testChangingContentWithCallbacks()
+    {
+        Response::morphed(function ($content, Response $response) {
+            $content['foo'] = 'bam!';
+
+            return $content;
+        });
+
+        Response::addFormatter('json', new Json);
+
+        $response = new Response(['foo' => 'bar']);
+
+        $this->assertEquals('{"foo":"bam!"}', $response->morph('json')->getContent());
+    }
+
+    public function testChangingResponseHeadersWithCallbacks()
+    {
+        Response::morphing(function ($content, Response $response) {
+            $response->headers->set('x-foo', 'bar');
+        });
+
+        Response::addFormatter('json', new Json);
+
+        $response = new Response(['foo' => 'bar']);
+
+        $this->assertEquals('bar', $response->morph('json')->headers->get('x-foo'));
+    }
 }