Context  

class Context extends Context

Properties

int|string|null $modelId
array|null $requestIncludes
$search
protected array $internal Data passed internally when reusing resource endpoint logic.
protected array $parameters Parameters mutated on the current instance.

Methods

__construct(JsonApi $api, ServerRequestInterface $request)

No description

array
fields(Resource $resource)

Get the fields for the given resource, keyed by name.

Context
withSearchResults(SearchResults $search)

No description

Context
withInternal(string $key, mixed $value)

No description

SearchResults|null
getSearchResults()

No description

mixed
internal(string $key, mixed $default = null)

No description

User
getActor()

No description

Context
setParam(string $key, mixed $default = null)

No description

mixed
getParam(string $key, mixed $default = null)

No description

bool
creating(string|null $resource = null)

No description

bool
updating(string|null $resource = null)

No description

bool
deleting(string|null $resource = null)

No description

bool
showing(string|null $resource = null)

No description

bool
listing(string|null $resource = null)

No description

Context
withRequest(ServerRequestInterface $request)

No description

Context
withModelId(int|string|null $id)

No description

Context
withRequestIncludes(array $requestIncludes)

No description

string|null
extractIdFromPath(Context $context)

No description

Details

at line 40
__construct(JsonApi $api, ServerRequestInterface $request)

Parameters

JsonApi $api
ServerRequestInterface $request

at line 52
array fields(Resource $resource)

Get the fields for the given resource, keyed by name.

Parameters

Resource $resource

Return Value

array

at line 68
Context withSearchResults(SearchResults $search)

Parameters

SearchResults $search

Return Value

Context

at line 76
Context withInternal(string $key, mixed $value)

Parameters

string $key
mixed $value

Return Value

Context

at line 84
SearchResults|null getSearchResults()

Return Value

SearchResults|null

at line 89
mixed internal(string $key, mixed $default = null)

Parameters

string $key
mixed $default

Return Value

mixed

at line 94
User getActor()

Return Value

User

at line 99
Context setParam(string $key, mixed $default = null)

Parameters

string $key
mixed $default

Return Value

Context

at line 106
mixed getParam(string $key, mixed $default = null)

Parameters

string $key
mixed $default

Return Value

mixed

at line 111
bool creating(string|null $resource = null)

Parameters

string|null $resource

Return Value

bool

at line 116
bool updating(string|null $resource = null)

Parameters

string|null $resource

Return Value

bool

at line 121
bool deleting(string|null $resource = null)

Parameters

string|null $resource

Return Value

bool

at line 126
bool showing(string|null $resource = null)

Parameters

string|null $resource

Return Value

bool

at line 131
bool listing(string|null $resource = null)

Parameters

string|null $resource

Return Value

bool

at line 136
Context withRequest(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

Context

at line 144
Context withModelId(int|string|null $id)

Parameters

int|string|null $id

Return Value

Context

at line 152
Context withRequestIncludes(array $requestIncludes)

Parameters

array $requestIncludes

Return Value

Context

at line 160
string|null extractIdFromPath(Context $context)

Parameters

Context $context

Return Value

string|null