\App\Api\RequestGlobalDataRequest

Request that contains global variables that the frontend might request repeatedly.

Summary

Methods
Properties
Constants
setHttpRequest()
get()
No public properties found
No constants found
shouldResolve()
rules()
_rules()
jsonParameters()
doResolve()
authorizationError()
$httpRequest
N/A
No private methods found
No private properties found
N/A

Properties

$httpRequest

$httpRequest : \Illuminate\Http\Request

HTTP request

Type

\Illuminate\Http\Request

Methods

setHttpRequest()

setHttpRequest(\Illuminate\Http\Request  $httpRequest) 

Parameters

\Illuminate\Http\Request $httpRequest

get()

get(\Illuminate\Http\Request  $request) : array

Get the data.

Parameters

\Illuminate\Http\Request $request

Returns

array

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

true|string

rules()

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

Returns validation rules for the request parameters

Parameters

\Illuminate\Support\Collection $parameters
\Illuminate\Validation\Validator $validator

Returns

array

_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

\Illuminate\Support\Collection $parameters
\Illuminate\Validation\Validator $validator

Returns

array

jsonParameters()

jsonParameters() : array<mixed,string>

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

Returns

array<mixed,string>

doResolve()

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

This function is called only when all validation passed.

Should return a Response.

Parameters

string $name
\Illuminate\Support\Collection $parameters

Returns

\App\Api\Response\Response

authorizationError()

authorizationError() 

Throws

\Illuminate\Auth\Access\AuthorizationException