Documentation

ApiRequest implements ContainerAwareInterface, ToSchemaJsonInterface, JsonSerializable Uses ContainerAwareTrait

Interfaces, Classes and Traits

ContainerAwareInterface
ToSchemaJsonInterface
JsonSerializable

Table of Contents

$actionName  : string
$api  : Api
$container  : Container
$data  : array<string|int, mixed>
$fields  : RequestedFields
$fieldsToSave  : FieldsToSave
$filters  : array<string|int, mixed>
$params  : array<string|int, mixed>
$resourceType  : string
$scopes  : array<string|int, mixed>
actionName()  : ApiRequest
api()  : ApiRequest
container()  : void
created()  : void
dispatch()  : mixed
fields()  : ApiRequest
fieldsToSave()  : ApiRequest
filter()  : ApiRequest
filters()  : ApiRequest
fromInput()  : ApiRequest
getAction()  : Action
getFields()  : RequestedFields
getFieldsToSave()  : FieldsToSave
getFilters()  : array<string|int, mixed>
getParam()  : mixed
getParams()  : array<string|int, mixed>
getResource()  : Resource
getScopes()  : array<string|int, mixed>
hasParam()  : bool
jsonSerialize()  : mixed
params()  : ApiRequest
resourceType()  : ApiRequest
scope()  : ApiRequest
scopes()  : ApiRequest
toSchemaJson()  : array<string|int, mixed>

Properties

$data

protected array<string|int, mixed> $data = []

$filters

protected array<string|int, mixed> $filters = []

$params

protected array<string|int, mixed> $params = []

$scopes

protected array<string|int, mixed> $scopes = []

Methods

dispatch()

public dispatch() : mixed
Return values
mixed —

fieldsToSave()

public fieldsToSave(array<string|int, mixed> $fields) : ApiRequest
Parameters
$fields : array<string|int, mixed>
Return values
ApiRequest —

filters()

public filters(array<string|int, mixed> $filters) : ApiRequest
Parameters
$filters : array<string|int, mixed>
Return values
ApiRequest —

getFilters()

public getFilters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getParam()

public getParam(string $name) : mixed
Parameters
$name : string
Return values
mixed —

getParams()

public getParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getScopes()

public getScopes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

hasParam()

public hasParam(string $name) : bool
Parameters
$name : string
Return values
bool —

jsonSerialize()

public jsonSerialize() : mixed
Return values
mixed —

toSchemaJson()

public toSchemaJson() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results