API Documentation
\
App
Api
Data
Request
Auth
DB
Chat
Offer
User
Response
Auth
Console
Commands
DevCommands
Translation
Eloquent
Order
Events
Exceptions
Facades
Helpers
Http
Controllers
Auth
Middleware
Resources
Jobs
Listeners
Notifications
Observers
Packages
Providers
Rules
Tests

\App\Api\RequestInitialDataRequest

Request that contains variables that the frontend might require at the beginning of its existence.

Extends GlobalRequest.

Summary

Methods
Properties
Constants
get()
setHttpRequest()
No public properties found
No constants found
doResolve()
shouldResolve()
rules()
_rules()
jsonParameters()
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

get()

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

Get the data.

Parameters

\Illuminate\Http\Request $request

Returns

array

setHttpRequest()

setHttpRequest(\Illuminate\Http\Request  $httpRequest)

Parameters

\Illuminate\Http\Request $httpRequest

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

$name
\Illuminate\Support\Collection $parameters

Throws

\Illuminate\Validation\ValidationException

Returns

\App\Api\Response\Response

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>

authorizationError()

authorizationError()

Throws

\Illuminate\Auth\Access\AuthorizationException