Allow meta data to be added with the response builder.

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

Author: jasonlewis

src/Http/ResponseBuilder.php

@@ -42,6 +42,13 @@ class ResponseBuilder
      */
     protected $serializer;
 
+    /**
+     * Array of meta data.
+     * 
+     * @var array
+     */
+    protected $meta = [];
+
     /**
      * Create a new response builder instance.
      *
@@ -134,6 +141,32 @@ public function withError($error, $statusCode)
         return $this->setStatusCode($statusCode)->withArray($error);
     }
 
+    /**
+     * Add a Fractal meta key and value pair.
+     * 
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return \Dingo\Api\Http\ResponseBuilder
+     */
+    public function addMeta($key, $value)
+    {
+        $this->meta[$key] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Add a Fractal meta key and value pair.
+     * 
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return \Dingo\Api\Http\ResponseBuilder
+     */
+    public function meta($key, $value)
+    {
+        return $this->addMeta($key, $value);
+    }
+
     /**
      * Build the response.
      *
@@ -145,6 +178,10 @@ protected function build($data)
         if ($data instanceof FractalResourceInterface) {
             $fractal = $this->resolveFractal();
 
+            foreach ($this->meta as $key => $value) {
+                $data->setMetaValue($key, $value);
+            }
+
             if ($this->serializer) {
                 $fractal->setSerializer($this->serializer);
             }
@@ -169,6 +206,7 @@ protected function reset()
         $this->serializer = null;
         $this->statusCode = 200;
         $this->headers = [];
+        $this->meta = [];
     }
 
     /**