Merge pull request #8 from dextermb/feature/set-response-meta

Add the ability to add custom meta to the response

Author: Jordan Hall

src/DataTableResponder.php

@@ -4,6 +4,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Http\Request;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 
 /**
@@ -42,6 +43,11 @@ class DataTableResponder
      */
     private $perPage = 15;
 
+    /**
+     * @var array
+     */
+    private $meta = [];
+
     /**
      * DataTableResponder constructor.
      *
@@ -110,6 +116,20 @@ public function collectionManipulator(callable $collectionManipulator)
         return $this;
     }
 
+    /**
+     * Sets the meta for the API response
+     * 
+     * @see DataTableResponder::makeMeta
+     * 
+     * @param callable $collectionManipulator
+     * @return DataTableResponder
+     */
+    public function setResponseMeta(array $meta = [])
+    {
+        $this->meta = $meta;
+        return $this;
+    }
+
     /**
      * Builds the Eloquent query based on the request.
      *
@@ -172,6 +192,41 @@ private function manipulateCollection($results)
         return $results;
     }
 
+    /**
+     * Make response meta
+     * 
+     * If a callable is given as an element value then
+     * the query and collection as parameters
+     * 
+     * `disallow_ordering_by` will always be overwritten
+     * as it is managed internally
+     * 
+     * @param Builder $query
+     * @param Collection $collection
+     * @return array
+     */
+    private function makeMeta(Builder $query, Collection $collection)
+    {
+        $meta = $this->meta;
+        $out = [];
+
+        foreach($meta as $element => $value) {
+            if (is_callable($value)) {
+                $out[$element] = call_user_func_array(
+                    $value, [$query, $collection]
+                );
+
+                continue;
+            }
+
+            $out[$element] = $value;
+        }
+
+        $out['disallow_ordering_by'] = $this->disallowOrderingBy();
+
+        return $out;
+    }
+
     /**
      * @return array|string[]
      */
@@ -210,9 +265,8 @@ public function respond()
 
         $results = $this->paginateQuery($query);
         $results = $this->manipulateCollection($results);
+        $meta = $this->makeMeta($query, $results->getCollection());
 
-        $disallowOrderingBy = $this->disallowOrderingBy();
-
-        return DataTableResponse::success($results, ['disallow_ordering_by' => $disallowOrderingBy])->json();
+        return DataTableResponse::success($results, $meta)->json();
     }
 }