X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/b8c16b15a9f945b72d2ca4fe0c0172ba422199bc..refs/pull/3039/head:/app/Api/ListingResponseBuilder.php diff --git a/app/Api/ListingResponseBuilder.php b/app/Api/ListingResponseBuilder.php index 2fa5644c3..02b3f680c 100644 --- a/app/Api/ListingResponseBuilder.php +++ b/app/Api/ListingResponseBuilder.php @@ -1,4 +1,6 @@ - '<', 'gte' => '>=', 'lte' => '<=', - 'like' => 'like' + 'like' => 'like', ]; /** @@ -36,11 +37,13 @@ class ListingResponseBuilder */ public function toResponse() { - $data = $this->fetchData(); - $total = $this->query->count(); + $filteredQuery = $this->filterQuery($this->query); + + $total = $filteredQuery->count(); + $data = $this->fetchData($filteredQuery); return response()->json([ - 'data' => $data, + 'data' => $data, 'total' => $total, ]); } @@ -48,23 +51,23 @@ class ListingResponseBuilder /** * Fetch the data to return in the response. */ - protected function fetchData(): Collection + protected function fetchData(Builder $query): Collection { - $this->applyCountAndOffset($this->query); - $this->applySorting($this->query); - $this->applyFiltering($this->query); + $query = $this->countAndOffsetQuery($query); + $query = $this->sortQuery($query); - return $this->query->get($this->fields); + return $query->get($this->fields); } /** * Apply any filtering operations found in the request. */ - protected function applyFiltering(Builder $query) + protected function filterQuery(Builder $query): Builder { + $query = clone $query; $requestFilters = $this->request->get('filter', []); if (!is_array($requestFilters)) { - return; + return $query; } $queryFilters = collect($requestFilters)->map(function ($value, $key) { @@ -73,7 +76,7 @@ class ListingResponseBuilder return !is_null($value); })->values()->toArray(); - $query->where($queryFilters); + return $query->where($queryFilters); } /** @@ -94,6 +97,7 @@ class ListingResponseBuilder } $queryOperator = $this->filterOperators[$filterOperator]; + return [$field, $queryOperator, $value]; } @@ -101,8 +105,9 @@ class ListingResponseBuilder * Apply sorting operations to the query from given parameters * otherwise falling back to the first given field, ascending. */ - protected function applySorting(Builder $query) + protected function sortQuery(Builder $query): Builder { + $query = clone $query; $defaultSortName = $this->fields[0]; $direction = 'asc'; @@ -116,20 +121,21 @@ class ListingResponseBuilder $sortName = $defaultSortName; } - $query->orderBy($sortName, $direction); + return $query->orderBy($sortName, $direction); } /** * Apply count and offset for paging, based on params from the request while falling * back to system defined default, taking the max limit into account. */ - protected function applyCountAndOffset(Builder $query) + protected function countAndOffsetQuery(Builder $query): Builder { + $query = clone $query; $offset = max(0, $this->request->get('offset', 0)); $maxCount = config('api.max_item_count'); $count = $this->request->get('count', config('api.default_item_count')); $count = max(min($maxCount, $count), 1); - $query->skip($offset)->take($count); + return $query->skip($offset)->take($count); } }