abstract class AbstractDatabaseResource extends AbstractResource implements Findable, Listable, Countable, Paginatable, Creatable, Updatable, Deletable
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 |
|
Methods
Called by the JSON:API server package to resolve the validation factory.
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.
Details
Factory
validationFactory()
Called by the JSON:API server package to resolve the validation factory.
in Extendable
at
line 22
static void
mutateEndpoints(callable $modifier)
in Extendable
at
line 27
static void
mutateFields(callable $modifier)
in Extendable
at
line 32
static void
mutateSorts(callable $modifier)
in Extendable
at
line 37
array
resolveEndpoints(bool $earlyResolution = false)
in Extendable
at
line 56
array
resolveFields()
in Extendable
at
line 75
array
resolveSorts()
in HasSortMap
at
line 16
array
sortMap()
in DispatchEventsTrait
at
line 19
void
dispatchEventsFor(mixed $entity, User|null $actor = null)
Dispatch all events for an entity.
in AbstractResource
at
line 30
string|null
id( Context $context)
in AbstractResource
at
line 35
string|null
routeNamePrefix()
at
line 43
abstract string
model()
at
line 49
string|null
resource(object $model, Context $context)
at
line 64
string
getId(object $model, Context $context)
at
line 73
mixed
getValue(object $model, Field $field, Context $context)
at
line 120
protected mixed
getRelationshipValue( Model $model, Relationship $field, Context $context)
at
line 169
object
query( Context $context)
at
line 192
iterable
results(object $query, Context $context)
at
line 204
void
paginate(object $query, OffsetPagination $pagination)
at
line 213
int|null
count(object $query, Context $context)
at
line 225
object|null
find(string $id, Context $context)
at
line 241
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.
at
line 251
void
setValue(object $model, Field $field, mixed $value, Context $context)
at
line 287
void
saveValue(object $model, Field $field, mixed $value, Context $context)
at
line 303
object
create(object $model, Context $context)
at
line 314
object
update(object $model, Context $context)
at
line 334
void
delete(object $model, Context $context)
at
line 342
protected string
property( Field $field)
Get the model property that a field represents.
at
line 350
protected string
method( Field $field)
Get the model method that a field represents.
at
line 356
object
newModel( Context $context)
at
line 361
final array
filters()
Filters that can be applied to the resource list.