Update
class Update extends Endpoint
Traits
SavesData
HasMeta
IncludesData
IncludesData
HasVisibility
FindsResources
HasMeta
IncludesData
HasVisibility
Properties
| protected array<string| callable> | $loadRelations | from HasEagerLoading |
|
|
| protected array<string, callable> | $loadRelationWhere | from HasEagerLoading |
|
|
| protected bool| Closure | $authenticated | from HasAuthorization |
|
|
| protected null|string| Closure | $ability | from HasAuthorization |
|
|
| protected bool | $admin | from HasAuthorization |
|
|
| protected array | $before | from HasHooks |
|
|
| protected array | $after | from HasHooks |
|
|
| protected Closure|null | $extractFilterCallback | from ExtractsListingParams |
|
|
| protected Closure|null | $extractSortCallback | from ExtractsListingParams |
|
|
| protected Closure|null | $extractLimitCallback | from ExtractsListingParams |
|
|
| protected Closure|null | $extractOffsetCallback | from ExtractsListingParams |
|
|
| int|null | $limit | from ExtractsListingParams |
|
|
| int | $maxLimit | from ExtractsListingParams |
|
|
| string|null | $defaultSort | from ExtractsListingParams |
|
|
| string | $method | from Endpoint |
|
|
| string | $path | from Endpoint |
|
|
| protected Closure|null | $action | from Endpoint |
|
|
| protected Closure|null | $response | from Endpoint |
|
|
| protected array | $beforeSerialization | from Endpoint |
|
Methods
from HasEagerLoading
eagerLoadWhenIncluded(array $includedToRelations)
Eager load relations when a relation is included in the serialized response.
from HasEagerLoading
eagerLoadWhere(string $relation, callable $callback)
Allows loading a relationship with additional query modification.
from HasEagerLoading
void
loadRelations( Collection $models, Context $context, array $included = [])
Eager loads relationships before serialization.
from HasEagerLoading
array
compileSimpleEagerLoads( Context $context, array $included)
No description
from HasEagerLoading
array
getWhereEagerLoadsFor(string $included, Context $context)
The constrained eager loads beneath a relationship the serializer is loading, for `with()` on its query: keyed by the path below it, with their constraints, as compileWhereEagerLoads() gives the top level.
from HasEagerLoading
from HasAuthorization
void
assertDataValid( Context $context, array $data)
Assert that the field values within a data object pass validation.
Details
in ShowsResources
at
line 22
protected array
showResource( Context $context, mixed $model)
in HasEagerLoading
at
line 45
HasEagerLoading
eagerLoad(array|string| Closure $relations)
Eager loads relationships needed for serializer logic.
in HasEagerLoading
at
line 61
HasEagerLoading
eagerLoadWhenIncluded(array $includedToRelations)
Eager load relations when a relation is included in the serialized response.
in HasEagerLoading
at
line 87
HasEagerLoading
eagerLoadWhere(string $relation, callable $callback)
Allows loading a relationship with additional query modification.
in HasEagerLoading
at
line 97
protected void
loadRelations( Collection $models, Context $context, array $included = [])
Eager loads relationships before serialization.
in HasEagerLoading
at
line 348
protected array
compileSimpleEagerLoads( Context $context, array $included)
in HasEagerLoading
at
line 364
protected array
compileWhereEagerLoads( Context $context)
in HasEagerLoading
at
line 374
array
getEagerLoadsFor(string $included, Context $context)
in HasEagerLoading
at
line 399
array
getWhereEagerLoadsFor(string $included, Context $context)
The constrained eager loads beneath a relationship the serializer is loading, for `with()` on its query: keyed by the path below it, with their constraints, as compileWhereEagerLoads() gives the top level.
in HasAuthorization
at
line 31
HasAuthorization
authenticated(bool| Closure $condition = true)
in HasAuthorization
at
line 38
HasAuthorization
can(null|string| Closure $ability)
in HasAuthorization
at
line 45
HasAuthorization
admin(bool $admin = true)
in HasAuthorization
at
line 52
bool
getAuthenticated( Context $context)
in HasAuthorization
at
line 63
string|null
getAuthorized( Context $context)
in HasAuthorization
at
line 78
bool
isVisible( Context $context)
protected callable
resolveCallable(callable|string $callable, Context $context)
in ExtractsListingParams
at
line 29
ExtractsListingParams
limit(int $limit)
in ExtractsListingParams
at
line 36
ExtractsListingParams
maxLimit(int $maxLimit)
in ExtractsListingParams
at
line 43
ExtractsListingParams
extractFilter( Closure $callback)
in ExtractsListingParams
at
line 50
ExtractsListingParams
extractSort( Closure $callback)
in ExtractsListingParams
at
line 57
ExtractsListingParams
extractLimit( Closure $callback)
in ExtractsListingParams
at
line 64
ExtractsListingParams
extractOffset( Closure $callback)
in ExtractsListingParams
at
line 71
array
extractFilterValue( Context $context, array $defaultExtracts)
in ExtractsListingParams
at
line 78
array|null
extractSortValue( Context $context, array $defaultExtracts)
in ExtractsListingParams
at
line 87
int|null
extractLimitValue( Context $context, array $defaultExtracts)
in ExtractsListingParams
at
line 94
int
extractOffsetValue( Context $context, array $defaultExtracts)
array
defaultExtracts( Context $context)
array
getAvailableSorts( Context $context)
at
line 36
void
setUp()
in SavesAndValidatesData
at
line 37
protected void
assertDataValid( Context $context, array $data)
Assert that the field values within a data object pass validation.
in SavesAndValidatesData
at
line 94
protected void
validate(string $type, Validator $validator)
protected array
mutateDataBeforeValidation( Context $context, array $data)
final protected array
parseData( Context $context)
Parse and validate a JSON:API document's `data` member.