AccessTokenResource  

class AccessTokenResource extends AbstractDatabaseResource

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

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

from AbstractResource
string|null
routeNamePrefix()

No description

from AbstractResource
string
model()

No description

string|null
resource(object $model, Context $context)

No description

from AbstractDatabaseResource
string
getId(object $model, Context $context)

No description

from AbstractDatabaseResource
mixed
getValue(object $model, Field $field, Context $context)

No description

from AbstractDatabaseResource
mixed
getAttributeValue(Model $model, Field $field, Context $context)

No description

from AbstractDatabaseResource
mixed
getRelationshipValue(Model $model, Relationship $field, Context $context)

No description

from AbstractDatabaseResource
object
query(Context $context)

No description

from AbstractDatabaseResource
void
scope(Builder $query, Context $context)

Hook to scope a query for this resource.

iterable
results(object $query, Context $context)

No description

from AbstractDatabaseResource
void
paginate(object $query, OffsetPagination $pagination)

No description

from AbstractDatabaseResource
int|null
count(object $query, Context $context)

No description

from AbstractDatabaseResource
object|null
find(string $id, Context $context)

No description

from AbstractDatabaseResource
void
setValue(object $model, Field $field, mixed $value, Context $context)

No description

from AbstractDatabaseResource
void
saveValue(object $model, Field $field, mixed $value, Context $context)

No description

from AbstractDatabaseResource
object
create(object $model, Context $context)

No description

from AbstractDatabaseResource
object
update(object $model, Context $context)

No description

from AbstractDatabaseResource
void
saveModel(Model $model, Context $context)

No description

from AbstractDatabaseResource
void
delete(object $model, Context $context)

No description

string
property(Field $field)

Get the model property that a field represents.

from AbstractDatabaseResource
string
method(Field $field)

Get the model method that a field represents.

from AbstractDatabaseResource
object
newModel(Context $context)

No description

array
filters()

Filters that can be applied to the resource list.

from AbstractDatabaseResource
array
mutateDataBeforeValidation(Context $context, array $data)

No description

from AbstractDatabaseResource
__construct(TranslatorInterface $translator)

No description

string
type()

No description

array
endpoints()

No description

array
fields()

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

at line 114
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

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

Parameters

Context $context

Return Value

string|null

in AbstractResource at line 35
string|null routeNamePrefix()

Return Value

string|null

at line 42
string model()

Return Value

string

in AbstractDatabaseResource at line 49
string|null resource(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

string|null

in AbstractDatabaseResource at line 64
string getId(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

string

in AbstractDatabaseResource at line 73
mixed getValue(object $model, Field $field, Context $context)

Parameters

object $model
Field $field
Context $context

Return Value

mixed

in AbstractDatabaseResource at line 86
protected mixed getAttributeValue(Model $model, Field $field, Context $context)

Parameters

Model $model
Field $field
Context $context

Return Value

mixed

in AbstractDatabaseResource at line 116
protected mixed getRelationshipValue(Model $model, Relationship $field, Context $context)

Parameters

Model $model
Relationship $field
Context $context

Return Value

mixed

in AbstractDatabaseResource at line 161
object query(Context $context)

Parameters

Context $context

Return Value

object

at line 47
void scope(Builder $query, Context $context)

Hook to scope a query for this resource.

Parameters

Builder $query
Context $context

Return Value

void

in AbstractDatabaseResource at line 184
iterable results(object $query, Context $context)

Parameters

object $query
Context $context

Return Value

iterable

in AbstractDatabaseResource at line 196
void paginate(object $query, OffsetPagination $pagination)

Parameters

object $query
OffsetPagination $pagination

Return Value

void

in AbstractDatabaseResource at line 205
int|null count(object $query, Context $context)

Parameters

object $query
Context $context

Return Value

int|null

in AbstractDatabaseResource at line 217
object|null find(string $id, Context $context)

Parameters

string $id
Context $context

Return Value

object|null

in AbstractDatabaseResource at line 227
void setValue(object $model, Field $field, mixed $value, Context $context)

Parameters

object $model
Field $field
mixed $value
Context $context

Return Value

void

Exceptions

Exception

in AbstractDatabaseResource at line 263
void saveValue(object $model, Field $field, mixed $value, Context $context)

Parameters

object $model
Field $field
mixed $value
Context $context

Return Value

void

in AbstractDatabaseResource at line 279
object create(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object

in AbstractDatabaseResource at line 290
object update(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object

in AbstractDatabaseResource at line 301
protected void saveModel(Model $model, Context $context)

Parameters

Model $model
Context $context

Return Value

void

at line 126
void delete(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

void

Exceptions

PermissionDeniedException

in AbstractDatabaseResource at line 318
protected string property(Field $field)

Get the model property that a field represents.

Parameters

Field $field

Return Value

string

in AbstractDatabaseResource at line 326
protected string method(Field $field)

Get the model method that a field represents.

Parameters

Field $field

Return Value

string

at line 52
object newModel(Context $context)

Parameters

Context $context

Return Value

object

in AbstractDatabaseResource at line 337
final array filters()

Filters that can be applied to the resource list.

Return Value

array

in AbstractDatabaseResource at line 345
array mutateDataBeforeValidation(Context $context, array $data)

Parameters

Context $context
array $data

Return Value

array

at line 32
__construct(TranslatorInterface $translator)

Parameters

TranslatorInterface $translator

at line 37
string type()

Return Value

string

at line 64
array endpoints()

Return Value

array

at line 78
array fields()

Return Value

array