Added a custom link context toolbar

[bookstack] / app / Api / ListingResponseBuilder.php

diff --git a/app/Api/ListingResponseBuilder.php b/app/Api/ListingResponseBuilder.php
index 3dbe954b8b7693bbeb0ec5c43bbfe948b2814b7f..7de5ddf07b133302820396f8847dc70523ad096a 100644 (file)
--- a/app/Api/ListingResponseBuilder.php
+++ b/app/Api/ListingResponseBuilder.php
@@ -2,8 +2,10 @@
 
 namespace BookStack\Api;
 
+use BookStack\Model;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 
 class ListingResponseBuilder
@@ -11,7 +13,11 @@ class ListingResponseBuilder
     protected $query;
     protected $request;
     protected $fields;
-    protected $hiddenFields;
+
+    /**
+     * @var array<callable>
+     */
+    protected $resultModifiers = [];
 
     protected $filterOperators = [
         'eq'   => '=',
@@ -25,25 +31,28 @@ class ListingResponseBuilder
 
     /**
      * ListingResponseBuilder constructor.
+     * The given fields will be forced visible within the model results.
      */
-    public function __construct(Builder $query, Request $request, array $fields, array $hiddenFields )
+    public function __construct(Builder $query, Request $request, array $fields)
     {
         $this->query = $query;
         $this->request = $request;
         $this->fields = $fields;
-        $this->hiddenFields = $hiddenFields;
     }
 
     /**
      * Get the response from this builder.
      */
-    public function toResponse()
+    public function toResponse(): JsonResponse
     {
         $filteredQuery = $this->filterQuery($this->query);
 
         $total = $filteredQuery->count();
-        $data = $this->fetchData($filteredQuery);
-        $data = $data->makeVisible($this->hiddenFields);
+        $data = $this->fetchData($filteredQuery)->each(function ($model) {
+            foreach ($this->resultModifiers as $modifier) {
+                $modifier($model);
+            }
+        });
 
         return response()->json([
             'data'  => $data,
@@ -52,7 +61,17 @@ class ListingResponseBuilder
     }
 
     /**
-     * Fetch the data to return in the response.
+     * Add a callback to modify each element of the results.
+     *
+     * @param (callable(Model)) $modifier
+     */
+    public function modifyResults($modifier): void
+    {
+        $this->resultModifiers[] = $modifier;
+    }
+
+    /**
+     * Fetch the data to return within the response.
      */
     protected function fetchData(Builder $query): Collection
     {