]> BookStack Code Mirror - bookstack/blob - app/Http/Controllers/Api/ApiController.php
Added API listing filtering & cleaned ApiAuthenticate returns
[bookstack] / app / Http / Controllers / Api / ApiController.php
1 <?php namespace BookStack\Http\Controllers\Api;
2
3 use BookStack\Api\ListingResponseBuilder;
4 use BookStack\Http\Controllers\Controller;
5 use Illuminate\Database\Eloquent\Builder;
6 use Illuminate\Http\JsonResponse;
7
8 class ApiController extends Controller
9 {
10
11     /**
12      * Provide a paginated listing JSON response in a standard format
13      * taking into account any pagination parameters passed by the user.
14      */
15     protected function apiListingResponse(Builder $query, array $fields): JsonResponse
16     {
17         $listing = new ListingResponseBuilder($query, request(), $fields);
18         return $listing->toResponse();
19     }
20 }