JsonApi  

class JsonApi extends JsonApi

Properties

protected string $resourceClass
protected string $endpointName
protected ServerRequestInterface|null $baseRequest
protected Container|null $container

Methods

JsonApi
forResource(string $resourceClass)

No description

JsonApi
forEndpoint(string $endpointName)

No description

Context
makeContext(ServerRequestInterface $request)

No description

Endpoint
findEndpoint(Collection|null $collection)

No description

Collection
getCollection(string $type)

Get a collection by name or class.

Resource
getResource(string $type)

Get a resource by type or class.

JsonApi
withRequest(ServerRequestInterface $request)

No description

ResponseInterface
handle(ServerRequestInterface $request)

No description

mixed
process(array $body, array $internal = [], array $options = [])

No description

void
validateQueryParameters(ServerRequestInterface $request)

No description

string|null
typeForModel(string $modelClass)

No description

array
typesForModels(array $modelClasses)

No description

JsonApi
container(Container $container)

No description

Container|null
getContainer()

No description

Details

at line 35
JsonApi forResource(string $resourceClass)

Parameters

string $resourceClass

Return Value

JsonApi

at line 42
JsonApi forEndpoint(string $endpointName)

Parameters

string $endpointName

Return Value

JsonApi

at line 49
protected Context makeContext(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

Context

at line 62
protected Endpoint findEndpoint(Collection|null $collection)

Parameters

Collection|null $collection

Return Value

Endpoint

at line 83
Collection getCollection(string $type)

Get a collection by name or class.

Parameters

string $type

Return Value

Collection

Exceptions

ResourceNotFoundException

at line 103
Resource getResource(string $type)

Get a resource by type or class.

Parameters

string $type

Return Value

Resource

Exceptions

ResourceNotFoundException

at line 118
JsonApi withRequest(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

JsonApi

at line 125
ResponseInterface handle(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

ResponseInterface

at line 132
mixed process(array $body, array $internal = [], array $options = [])

Parameters

array $body
array $internal
array $options

Return Value

mixed

at line 176
void validateQueryParameters(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

void

at line 190
string|null typeForModel(string $modelClass)

Parameters

string $modelClass

Return Value

string|null

at line 201
array typesForModels(array $modelClasses)

Parameters

array $modelClasses

Return Value

array

at line 206
JsonApi container(Container $container)

Parameters

Container $container

Return Value

JsonApi

at line 213
Container|null getContainer()

Return Value

Container|null