AbstractResource  

abstract class AbstractResource extends AbstractResource

Traits

Bootable
Extendable
HasSortMap
HasHooks
DispatchEventsTrait

Properties

protected JsonApi $api from Bootable
protected Dispatcher $events from Bootable
protected Factory $validation from Bootable
static protected array $endpointModifiers from Extendable
static protected array $fieldModifiers from Extendable
static protected array $sortModifiers from Extendable
protected array|null $cachedEndpoints from Extendable
protected array|null $cachedFields from Extendable
protected array|null $cachedSorts from Extendable

Methods

Bootable
boot(JsonApi $api)

Avoids polluting the constructor of the resource with dependencies.

from Bootable
Factory
validationFactory()

Called by the JSON:API server package to resolve the validation factory.

from Bootable
static void
mutateEndpoints(callable $modifier)

No description

from Extendable
static void
mutateFields(callable $modifier)

No description

from Extendable
static void
mutateSorts(callable $modifier)

No description

from Extendable
array
resolveEndpoints(bool $earlyResolution = false)

No description

from Extendable
array
resolveFields()

No description

from Extendable
array
resolveSorts()

No description

from Extendable
array
sortMap()

No description

from HasSortMap
void
dispatchEventsFor(mixed $entity, User|null $actor = null)

Dispatch all events for an entity.

from DispatchEventsTrait
object
createAction(object $model, Context $context)

No description

from HasHooks
object
updateAction(object $model, Context $context)

No description

from HasHooks
void
deleteAction(object $model, Context $context)

No description

from HasHooks
object|null
creating(object $model, Context $context)

No description

from HasHooks
object|null
updating(object $model, Context $context)

No description

from HasHooks
object|null
saving(object $model, Context $context)

No description

from HasHooks
object|null
saved(object $model, Context $context)

No description

from HasHooks
object|null
created(object $model, Context $context)

No description

from HasHooks
object|null
updated(object $model, Context $context)

No description

from HasHooks
void
deleting(object $model, Context $context)

No description

from HasHooks
void
deleted(object $model, Context $context)

No description

from HasHooks
string|null
id(Context $context)

No description

string|null
routeNamePrefix()

No description

Details

in Bootable at line 25
Bootable boot(JsonApi $api)

Avoids polluting the constructor of the resource with dependencies.

Parameters

JsonApi $api

Return Value

Bootable

in Bootable at line 37
Factory validationFactory()

Called by the JSON:API server package to resolve the validation factory.

Return Value

Factory

in Extendable at line 22
static void mutateEndpoints(callable $modifier)

Parameters

callable $modifier

Return Value

void

in Extendable at line 27
static void mutateFields(callable $modifier)

Parameters

callable $modifier

Return Value

void

in Extendable at line 32
static void mutateSorts(callable $modifier)

Parameters

callable $modifier

Return Value

void

in Extendable at line 37
array resolveEndpoints(bool $earlyResolution = false)

Parameters

bool $earlyResolution

Return Value

array

in Extendable at line 56
array resolveFields()

Return Value

array

in Extendable at line 75
array resolveSorts()

Return Value

array

in HasSortMap at line 16
array sortMap()

Return Value

array

in DispatchEventsTrait at line 19
void dispatchEventsFor(mixed $entity, User|null $actor = null)

Dispatch all events for an entity.

Parameters

mixed $entity
User|null $actor

Return Value

void

in HasHooks at line 34
object createAction(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object

in HasHooks at line 61
object updateAction(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object

in HasHooks at line 88
void deleteAction(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

void

in HasHooks at line 110
object|null creating(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object|null

in HasHooks at line 120
object|null updating(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object|null

in HasHooks at line 130
object|null saving(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object|null

in HasHooks at line 140
object|null saved(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object|null

in HasHooks at line 150
object|null created(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object|null

in HasHooks at line 160
object|null updated(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object|null

in HasHooks at line 169
void deleting(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

void

in HasHooks at line 178
void deleted(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

void

at line 30
string|null id(Context $context)

Parameters

Context $context

Return Value

string|null

at line 35
string|null routeNamePrefix()

Return Value

string|null