Show  

class Show extends Endpoint

Traits

ShowsResources
IncludesData
HasAuthorization
ExtractsListingParams
HasCustomHooks
HasMeta
IncludesData
IncludesData
HasVisibility
HasHooks
ShowsResources
FindsResources
HasEagerLoading
This is directed at eager loading relationships apart from the request includes.
HasAuthorization
HasCustomHooks
ExtractsListingParams
HasMeta
IncludesData
HasVisibility
HasHooks

Properties

protected (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

array
showResource(Context $context, mixed $model)

No description

from ShowsResources
HasEagerLoading
eagerLoad(array|string|Closure $relations)

Eager loads relationships needed for serializer logic.

from HasEagerLoading
HasEagerLoading
eagerLoadWhenIncluded(array $includedToRelations)

Eager load relations when a relation is included in the serialized response.

from HasEagerLoading
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
compileWhereEagerLoads(Context $context)

No description

from HasEagerLoading
array
getEagerLoadsFor(string $included, Context $context)

No description

from HasEagerLoading
array
getWhereEagerLoadsFor(string $included, Context $context)

No description

from HasEagerLoading
HasAuthorization
authenticated(bool|Closure $condition = true)

No description

from HasAuthorization
HasAuthorization
can(null|string|Closure $ability)

No description

from HasAuthorization
HasAuthorization
admin(bool $admin = true)

No description

from HasAuthorization
bool
getAuthenticated(Context $context)

No description

from HasAuthorization
string|null
getAuthorized(Context $context)

No description

from HasAuthorization
bool
isVisible(Context $context)

No description

from HasAuthorization
HasHooks
before(callable|string $callback)

No description

from HasHooks
HasHooks
after(callable|string $callback)

No description

from HasHooks
callable
resolveCallable(callable|string $callable, Context $context)

No description

from HasHooks
void
callBeforeHook(Context $context)

No description

from HasHooks
mixed
callAfterHook(Context $context, mixed $data)

No description

from HasHooks
ExtractsListingParams
limit(int $limit)

No description

from ExtractsListingParams
ExtractsListingParams
maxLimit(int $maxLimit)

No description

from ExtractsListingParams
ExtractsListingParams
extractFilter(Closure $callback)

No description

from ExtractsListingParams
ExtractsListingParams
extractSort(Closure $callback)

No description

from ExtractsListingParams
ExtractsListingParams
extractLimit(Closure $callback)

No description

from ExtractsListingParams
ExtractsListingParams
extractOffset(Closure $callback)

No description

from ExtractsListingParams
array
extractFilterValue(Context $context, array $defaultExtracts)

No description

from ExtractsListingParams
array|null
extractSortValue(Context $context, array $defaultExtracts)

No description

from ExtractsListingParams
int|null
extractLimitValue(Context $context, array $defaultExtracts)

No description

from ExtractsListingParams
int
extractOffsetValue(Context $context, array $defaultExtracts)

No description

from ExtractsListingParams
array
defaultExtracts(Context $context)

No description

from ExtractsListingParams
array
getAvailableSorts(Context $context)

No description

from ExtractsListingParams
__construct(string $name)

No description

from Endpoint
static Endpoint
make(string|null $name = null)

No description

void
setUp()

No description

Endpoint
name(string $name)

No description

from Endpoint
Endpoint
action(Closure $action)

No description

from Endpoint
Endpoint
response(Closure $response)

No description

from Endpoint
Endpoint
route(string $method, string $path)

No description

from Endpoint
Endpoint
beforeSerialization(Closure $callback)

No description

from Endpoint
mixed
process(Context $context)

No description

from Endpoint
ResponseInterface|null
handle(Context $context)

No description

from Endpoint
IncludesData
addDefaultInclude(array $include)

No description

from IncludesData
IncludesData
removeDefaultInclude(array $include)

No description

from IncludesData

Details

in ShowsResources at line 22
protected array showResource(Context $context, mixed $model)

Parameters

Context $context
mixed $model

Return Value

array

in HasEagerLoading at line 38
HasEagerLoading eagerLoad(array|string|Closure $relations)

Eager loads relationships needed for serializer logic.

Parameters

array|string|Closure $relations

Return Value

HasEagerLoading

in HasEagerLoading at line 54
HasEagerLoading eagerLoadWhenIncluded(array $includedToRelations)

Eager load relations when a relation is included in the serialized response.

Parameters

array $includedToRelations An array of included relation to relations to load 'includedRelation' => ['relation1', 'relation2']

Return Value

HasEagerLoading

in HasEagerLoading at line 80
HasEagerLoading eagerLoadWhere(string $relation, callable $callback)

Allows loading a relationship with additional query modification.

Parameters

string $relation
callable $callback The callback to modify the query, should accept: - \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation $query: A query object. - Context $context: An instance of the API context. - array $relations: An array of relations that are to be loaded.

Return Value

HasEagerLoading

in HasEagerLoading at line 90
protected void loadRelations(Collection $models, Context $context, array $included = [])

Eager loads relationships before serialization.

Parameters

Collection $models
Context $context
array $included

Return Value

void

in HasEagerLoading at line 129
protected array compileSimpleEagerLoads(Context $context, array $included)

Parameters

Context $context
array $included

Return Value

array

in HasEagerLoading at line 145
protected array compileWhereEagerLoads(Context $context)

Parameters

Context $context

Return Value

array

in HasEagerLoading at line 155
array getEagerLoadsFor(string $included, Context $context)

Parameters

string $included
Context $context

Return Value

array

in HasEagerLoading at line 175
array getWhereEagerLoadsFor(string $included, Context $context)

Parameters

string $included
Context $context

Return Value

array

in HasAuthorization at line 31
HasAuthorization authenticated(bool|Closure $condition = true)

Parameters

bool|Closure $condition

Return Value

HasAuthorization

in HasAuthorization at line 38
HasAuthorization can(null|string|Closure $ability)

Parameters

null|string|Closure $ability

Return Value

HasAuthorization

in HasAuthorization at line 45
HasAuthorization admin(bool $admin = true)

Parameters

bool $admin

Return Value

HasAuthorization

in HasAuthorization at line 52
bool getAuthenticated(Context $context)

Parameters

Context $context

Return Value

bool

in HasAuthorization at line 63
string|null getAuthorized(Context $context)

Parameters

Context $context

Return Value

string|null

in HasAuthorization at line 78
bool isVisible(Context $context)

Parameters

Context $context

Return Value

bool

Exceptions

NotAuthenticatedException
PermissionDeniedException

in HasHooks at line 20
HasHooks before(callable|string $callback)

Parameters

callable|string $callback

Return Value

HasHooks

in HasHooks at line 27
HasHooks after(callable|string $callback)

Parameters

callable|string $callback

Return Value

HasHooks

in HasHooks at line 34
protected callable resolveCallable(callable|string $callable, Context $context)

Parameters

callable|string $callable
Context $context

Return Value

callable

in HasHooks at line 43
void callBeforeHook(Context $context)

Parameters

Context $context

Return Value

void

in HasHooks at line 51
mixed callAfterHook(Context $context, mixed $data)

Parameters

Context $context
mixed $data

Return Value

mixed

in ExtractsListingParams at line 29
ExtractsListingParams limit(int $limit)

Parameters

int $limit

Return Value

ExtractsListingParams

in ExtractsListingParams at line 36
ExtractsListingParams maxLimit(int $maxLimit)

Parameters

int $maxLimit

Return Value

ExtractsListingParams

in ExtractsListingParams at line 43
ExtractsListingParams extractFilter(Closure $callback)

Parameters

Closure $callback

Return Value

ExtractsListingParams

in ExtractsListingParams at line 50
ExtractsListingParams extractSort(Closure $callback)

Parameters

Closure $callback

Return Value

ExtractsListingParams

in ExtractsListingParams at line 57
ExtractsListingParams extractLimit(Closure $callback)

Parameters

Closure $callback

Return Value

ExtractsListingParams

in ExtractsListingParams at line 64
ExtractsListingParams extractOffset(Closure $callback)

Parameters

Closure $callback

Return Value

ExtractsListingParams

in ExtractsListingParams at line 71
array extractFilterValue(Context $context, array $defaultExtracts)

Parameters

Context $context
array $defaultExtracts

Return Value

array

in ExtractsListingParams at line 78
array|null extractSortValue(Context $context, array $defaultExtracts)

Parameters

Context $context
array $defaultExtracts

Return Value

array|null

in ExtractsListingParams at line 87
int|null extractLimitValue(Context $context, array $defaultExtracts)

Parameters

Context $context
array $defaultExtracts

Return Value

int|null

in ExtractsListingParams at line 94
int extractOffsetValue(Context $context, array $defaultExtracts)

Parameters

Context $context
array $defaultExtracts

Return Value

int

in ExtractsListingParams at line 101
array defaultExtracts(Context $context)

Parameters

Context $context

Return Value

array

in ExtractsListingParams at line 111
array getAvailableSorts(Context $context)

Parameters

Context $context

Return Value

array

in Endpoint at line 44
__construct(string $name)

Parameters

string $name

at line 28
static Endpoint make(string|null $name = null)

Parameters

string|null $name

Return Value

Endpoint

at line 33
void setUp()

Return Value

void

in Endpoint at line 62
Endpoint name(string $name)

Parameters

string $name

Return Value

Endpoint

in Endpoint at line 69
Endpoint action(Closure $action)

Parameters

Closure $action

Return Value

Endpoint

in Endpoint at line 76
Endpoint response(Closure $response)

Parameters

Closure $response

Return Value

Endpoint

in Endpoint at line 83
Endpoint route(string $method, string $path)

Parameters

string $method
string $path

Return Value

Endpoint

in Endpoint at line 91
Endpoint beforeSerialization(Closure $callback)

Parameters

Closure $callback

Return Value

Endpoint

in Endpoint at line 98
mixed process(Context $context)

Parameters

Context $context

Return Value

mixed

in Endpoint at line 110
ResponseInterface|null handle(Context $context)

Parameters

Context $context

Return Value

ResponseInterface|null

in IncludesData at line 16
IncludesData addDefaultInclude(array $include)

Parameters

array $include

Return Value

IncludesData

in IncludesData at line 23
IncludesData removeDefaultInclude(array $include)

Parameters

array $include

Return Value

IncludesData