Resource
abstract class Resource extends Primitive
Traits
Properties
| static protected array<string, null|list<object>|object> | $attributeCache | from ReadsAttributes | |
| protected null|array<string, mixed> | $meta | from HasMeta | |
| protected string | $name | from Primitive | |
| protected string | $title | from Primitive | |
| protected string | $description | from Primitive | |
| protected string | $uri | ||
| protected string | $mimeType | ||
| protected string | $defaultUriScheme |
Methods
Resolve the nearest matching attribute in the class hierarchy.
Resolve all matching attributes in the class hierarchy.
Set response metadata using an array or key-value pair.
Merge the resolved icons into the primitive array.
Determine whether the primitive may be registered for this request.
Convert the resource to a method call.
Convert the resource to an array.
Get the annotation types allowed on a resource.
Get the resource URI or URI template.
Get the resource MIME type.
Details
in
ReadsAttributes at line 24
protected mixed
resolveAttribute(string $attributeClass)
Resolve the nearest matching attribute in the class hierarchy.
in
ReadsAttributes at line 56
protected array
resolveAttributes(string $attributeClass)
Resolve all matching attributes in the class hierarchy.
in
ReadsAttributes at line 82
static void
flushState()
Flush all static state.
in
HasIcons at line 19
array
resolvedIcons()
Resolve icons from attributes and the primitive's icons method.
in
HasMeta at line 21
void
setMeta(array|string $meta, mixed $value = null)
Set response metadata using an array or key-value pair.
in
HasMeta at line 46
array
mergeMeta(array $baseArray)
Merge metadata into the given response array.
in
Primitive at line 34
string
name()
Get the primitive name.
in
Primitive at line 44
string
title()
Get the primitive title.
in
Primitive at line 54
string
description()
Get the primitive description.
in
Primitive at line 66
array|null
meta()
Get the primitive metadata.
in
Primitive at line 76
array
icons()
Get the primitive icons.
in
Primitive at line 89
protected array
mergeIcons(array $baseArray)
Merge the resolved icons into the primitive array.
in
Primitive at line 103
bool
eligibleForRegistration()
Determine whether the primitive may be registered for this request.
at line 62
array
toMethodCall()
Convert the resource to a method call.
at line 82
array
toArray()
Convert the resource to an array.
in
HasAnnotations at line 19
array
annotations()
Get the primitive annotations.
at line 112
protected array
allowedAnnotations()
Get the annotation types allowed on a resource.
at line 28
string
uri()
Get the resource URI or URI template.
at line 42
Cacheable|null
cacheable()
Get the resource's cache settings.
at line 50
string
mimeType()
Get the resource MIME type.