mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
4cbd1a9eb5
* add /users/{id} to get a single user * add variable to print fields that are otherwise hidden (e.g. email)
32 lines
916 B
PHP
32 lines
916 B
PHP
<?php namespace BookStack\Http\Controllers\Api;
|
|
|
|
use BookStack\Api\ListingResponseBuilder;
|
|
use BookStack\Http\Controllers\Controller;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Http\JsonResponse;
|
|
|
|
abstract class ApiController extends Controller
|
|
{
|
|
|
|
protected $rules = [];
|
|
protected $printHidden = [];
|
|
|
|
/**
|
|
* Provide a paginated listing JSON response in a standard format
|
|
* taking into account any pagination parameters passed by the user.
|
|
*/
|
|
protected function apiListingResponse(Builder $query, array $fields, array $protectedFieldsToPrint = []): JsonResponse
|
|
{
|
|
$listing = new ListingResponseBuilder($query, request(), $fields, $protectedFieldsToPrint);
|
|
return $listing->toResponse();
|
|
}
|
|
|
|
/**
|
|
* Get the validation rules for this controller.
|
|
*/
|
|
public function getValdationRules(): array
|
|
{
|
|
return $this->rules;
|
|
}
|
|
}
|