BookStack/app/Http/Controllers/Api/ApiController.php

30 lines
821 B
PHP
Raw Normal View History

2019-12-28 09:58:07 -05:00
<?php namespace BookStack\Http\Controllers\Api;
use BookStack\Api\ListingResponseBuilder;
use BookStack\Http\Controllers\Controller;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\JsonResponse;
2020-11-22 09:56:19 -05:00
abstract class ApiController extends Controller
2019-12-28 09:58:07 -05:00
{
protected $rules = [];
2019-12-28 09:58:07 -05:00
/**
* 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): JsonResponse
{
$listing = new ListingResponseBuilder($query, request(), $fields);
2019-12-28 09:58:07 -05:00
return $listing->toResponse();
}
/**
* Get the validation rules for this controller.
*/
public function getValdationRules(): array
{
return $this->rules;
}
2019-12-28 09:58:07 -05:00
}