\App\Api\RequestPaginatedRequest

setHttpRequest()

setHttpRequest(\Illuminate\Http\Request  $httpRequest) 

Parameters

shouldResolve()

shouldResolve() : true|string

Decides whether the request will be resolved.

If the request should not run, returns the error message. Otherwise returns true.

Returns

rules()

rules(\Illuminate\Support\Collection  $parameters, \Illuminate\Validation\Validator  $validator = null) : array

Returns validation rules for the request parameters

Parameters

Returns

_rules()

_rules(\Illuminate\Support\Collection  $parameters, \Illuminate\Validation\Validator  $validator = null) : array

Returns validation rules for the request parameters. Should be used by abstract classes and should always concatenate result with parent implementation

Parameters

Returns

jsonParameters()

jsonParameters() : array<mixed,string>

Returns an array of parameters that are JSON and should be converted to an array

Returns

doResolve()

doResolve(  $name, \Illuminate\Support\Collection  $parameters) : \App\Api\Response\Response

This function is called only when all validation passed.

Should return a Response.

Parameters

Returns

authorizationError()

authorizationError() 

Throws

\Illuminate\Auth\Access\AuthorizationException

isOrderBased()

isOrderBased(\Illuminate\Support\Collection  $parameters) : boolean

Whether AfterPaginator or regular Paginator should be used

Parameters

Returns

urlParameters()

urlParameters(\Illuminate\Support\Collection  $parameters) : array<mixed,string>

Returns an array of parameters that should be present in the URL get query in next/previous URLs

Parameters

Returns

_urlParameters()

_urlParameters(\Illuminate\Support\Collection  $parameters) : array<mixed,string>

Returns an array of parameters that should be present in the URL get query in next/previous URLs.

Should be used by abstract classes and should always concatenate result with parent implementation.

Parameters

Returns

paginator()

paginator(\Illuminate\Support\Collection  $parameters, integer  $perPage, integer|string|null  $pageOrAfter) : \Illuminate\Contracts\Pagination\Paginator

Returns a Paginator instance to be used

Parameters

Returns

onResults()

onResults(array<mixed,\Illuminate\Database\Eloquent\Model>|\Illuminate\Database\Eloquent\Model  $results) 

Called after the query is requested.

Parameters

resourceClass()

resourceClass(\Illuminate\Support\Collection  $parameters) : string|false

Returns name of a Resource class to be used. If false, no Resource class used

Parameters

Returns