statsable

README.md

@@ -80,6 +80,7 @@ Here is a quick look at what you can do using API search method:
           }
         ],
         "gates": ["create", "view"],
+        "stats": true,
         "page": 2,
         "limit": 10
     }

src/Concerns/Statsable.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Lomkit\Rest\Concerns;
+
+
+trait Statsable
+{
+    /**
+     * Custom stats resource.
+     *
+     * @param \Illuminate\Contracts\Database\Eloquent\Builder $query
+     *
+     * @return array
+     */
+    public function stats(\Illuminate\Contracts\Database\Eloquent\Builder $query): array
+    {
+        return [];
+    }
+}

src/Http/Resource.php

@@ -13,6 +13,7 @@
 use Lomkit\Rest\Concerns\Resource\Paginable;
 use Lomkit\Rest\Concerns\Resource\Relationable;
 use Lomkit\Rest\Concerns\Resource\Rulable;
+use Lomkit\Rest\Concerns\Statsable;
 use Lomkit\Rest\Http\Requests\RestRequest;
 use Lomkit\Rest\Instructions\Instructionable;
 
@@ -28,6 +29,7 @@ class Resource implements \JsonSerializable
     use Actionable;
     use Instructionable;
     use HasResourceHooks;
+    use Statsable;
 
     /**
      * The model the entry corresponds to.

src/Http/Response.php

@@ -8,6 +8,7 @@
 use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
+use Lomkit\Rest\Contracts\QueryBuilder;
 use Lomkit\Rest\Http\Requests\RestRequest;
 use Lomkit\Rest\Relations\Relation;
 
@@ -127,11 +128,7 @@ public function toResponse($request)
                 $this->responsable->perPage(),
                 $this->responsable->currentPage(),
                 $this->responsable->getOptions(),
-                $this->resource->isGatingEnabled() && in_array('create', $request->input('search.gates', [])) ? [
-                    config('rest.gates.key') => [
-                        config('rest.gates.names.authorized_to_create') => $this->resource->authorizedTo('create', $this->resource::newModel()::class),
-                    ],
-                ] : []
+                $this->meta($request),
             );
 
             $restLengthAwarePaginator->through(function ($model) use ($request) {
@@ -147,16 +144,28 @@ public function toResponse($request)
 
         return [
             'data' => $data ?? $this->map($this->responsable, $this->modelToResponse($this->responsable, $this->resource, $request->input('search', []))),
-            'meta' => array_merge(
-                $this->resource->isGatingEnabled() && in_array('create', $request->input('search.gates', [])) ? [
-                    config('rest.gates.key') => [
-                        config('rest.gates.names.authorized_to_create') => $this->resource->authorizedTo('create', $this->resource::newModel()::class),
-                    ],
-                ] : []
-            ),
+            'meta' => $this->meta($request),
         ];
     }
 
+    protected function meta($request)
+    {
+        $meta = [];
+
+        if($this->resource->isGatingEnabled() && in_array('create', $request->input('search.gates', []))) {
+            $meta = array_merge($meta, [config('rest.gates.key') => [
+                config('rest.gates.names.authorized_to_create') => $this->resource->authorizedTo('create', $this->resource::newModel()::class),
+            ]]);
+        }
+
+        if((bool) $request->input('search.stats')) {
+            $query = app()->make(QueryBuilder::class, ['resource' => $this->resource, 'query' => null])->search($request->input('search', []));
+            $meta = array_merge($meta, ['stats' => $this->resource->stats($query)]);
+        }
+
+        return $meta;
+    }
+
     /**
      * This map on each model returned by the API, use it at your ease.
      *