class PostResource extends AbstractDatabaseResource

Traits

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
static int $defaultLimit

Methods

boot( JsonApi $api)

Avoids polluting the constructor of the resource with dependencies.

from Bootable
validationFactory()

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

from Bootable
static void
mutateEndpoints(callable $modifier)

No description

static void
mutateFields(callable $modifier)

No description

static void
mutateSorts(callable $modifier)

No description

array
resolveEndpoints(bool $earlyResolution = false)

No description

array
resolveFields()

No description

array
resolveSorts()

No description

array
sortMap()

No description

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

Dispatch all events for an entity.

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

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

void
deleted(object $model, Context $context)

No description

from HasHooks
string|null
id( Context $context)

No description

string|null
routeNamePrefix()

No description

string
model()

No description

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

No description

string
getId(object $model, Context $context)

No description

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

No description

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

No description

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

No description

object
query( Context $context)

No description

void
scope( Builder $query, Context $context)

Hook to scope a query for this resource.

iterable
results(object $query, Context $context)

No description

void
paginate(object $query, OffsetPagination $pagination)

No description

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

No description

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

No description

bool
idCanBeKey( Model $model, string $id)

Whether the id can be a key of the model. An integer key only matches digits: databases treat anything else differently (MySQL reads "2abc" as 2, PostgreSQL rejects the query), so it is answered as not found.

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

No description

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

No description

object
create(object $model, Context $context)

No description

object
update(object $model, Context $context)

No description

void
saveModel( Model $model, Context $context)

No description

void
delete(object $model, Context $context)

No description

string
property( Field $field)

Get the model property that a field represents.

string
method( Field $field)

Get the model method that a field represents.

object
newModel( Context $context)

No description

array
filters()

Filters that can be applied to the resource list.

array
mutateDataBeforeValidation( Context $context, array $data)

No description

__construct( PostRepository $posts, TranslatorInterface $translator, LogReporter $log, Dispatcher $bus)

No description

string
type()

No description

array
endpoints()

No description

array
fields()

No description

bool
showsPostSource()

Whether the forum shows how posts were made. Read lazily, so subclasses' constructors are unaffected.

array
sorts()

Sorts that can be applied to the resource list.

Details

Bootable boot( JsonApi $api)

Avoids polluting the constructor of the resource with dependencies.

Parameters

JsonApi $api

Return Value

Bootable

Factory validationFactory()

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

Return Value

Factory

static void mutateEndpoints(callable $modifier)

Parameters

callable $modifier

Return Value

void

static void mutateFields(callable $modifier)

Parameters

callable $modifier

Return Value

void

static void mutateSorts(callable $modifier)

Parameters

callable $modifier

Return Value

void

array resolveEndpoints(bool $earlyResolution = false)

Parameters

bool $earlyResolution

Return Value

array

array resolveFields()

Return Value

array

array resolveSorts()

Return Value

array

array sortMap()

Return Value

array

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

Dispatch all events for an entity.

Parameters

mixed $entity
User|null $actor

Return Value

void

object createAction(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object

object updateAction(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object

void deleteAction(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

void

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

Parameters

object $model
Context $context

Return Value

object|null

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

Parameters

object $model
Context $context

Return Value

object|null

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

Parameters

object $model
Context $context

Return Value

object|null

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

Parameters

object $model
Context $context

Return Value

object|null

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

Parameters

object $model
Context $context

Return Value

object|null

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

Parameters

object $model
Context $context

Return Value

object|null

void deleting(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

void

void deleted(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

void

string|null id( Context $context)

Parameters

Context $context

Return Value

string|null

string|null routeNamePrefix()

Return Value

string|null

string model()

Return Value

string

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

Parameters

object $model
Context $context

Return Value

string|null

string getId(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

string

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

Parameters

object $model
Field $field
Context $context

Return Value

mixed

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

Parameters

Model $model
Field $field
Context $context

Return Value

mixed

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

Parameters

Model $model
Relationship $field
Context $context

Return Value

mixed

object query( Context $context)

Parameters

Context $context

Return Value

object

void scope( Builder $query, Context $context)

Hook to scope a query for this resource.

Parameters

Builder $query
Context $context

Return Value

void

iterable results(object $query, Context $context)

Parameters

object $query
Context $context

Return Value

iterable

void paginate(object $query, OffsetPagination $pagination)

Parameters

object $query
OffsetPagination $pagination

Return Value

void

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

Parameters

object $query
Context $context

Return Value

int|null

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

Parameters

string $id
Context $context

Return Value

object|null

protected bool idCanBeKey( Model $model, string $id)

Whether the id can be a key of the model. An integer key only matches digits: databases treat anything else differently (MySQL reads "2abc" as 2, PostgreSQL rejects the query), so it is answered as not found.

Parameters

Model $model
string $id

Return Value

bool

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

Parameters

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

Return Value

void

Exceptions

Exception

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

Parameters

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

Return Value

void

object create(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object

object update(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

object

protected void saveModel( Model $model, Context $context)

Parameters

Model $model
Context $context

Return Value

void

void delete(object $model, Context $context)

Parameters

object $model
Context $context

Return Value

void

protected string property( Field $field)

Get the model property that a field represents.

Parameters

Field $field

Return Value

string

protected string method( Field $field)

Get the model method that a field represents.

Parameters

Field $field

Return Value

string

object newModel( Context $context)

Parameters

Context $context

Return Value

object

final array filters()

Filters that can be applied to the resource list.

Return Value

array

array mutateDataBeforeValidation( Context $context, array $data)

Parameters

Context $context
array $data

Return Value

array

__construct( PostRepository $posts, TranslatorInterface $translator, LogReporter $log, Dispatcher $bus)

Parameters

PostRepository $posts
TranslatorInterface $translator
LogReporter $log
Dispatcher $bus

string type()

Return Value

string

array endpoints()

Return Value

array

array fields()

Return Value

array

protected bool showsPostSource()

Whether the forum shows how posts were made. Read lazily, so subclasses' constructors are unaffected.

Return Value

bool

array sorts()

Sorts that can be applied to the resource list.

Return Value

array