1. class
  2. Hypervel
  3. \
  4. Mcp
  5. \
  6. Server
  7. \
  8. Primitive

Primitive

abstract class Primitive implements Arrayable

Traits

HasIcons
HasMeta
ReadsAttributes

Properties

static protected array<string, null|list<object>|object> $attributeCache from  ReadsAttributes
protected null|array<string, mixed> $meta from  HasMeta
protected string $name
protected string $title
protected string $description

Methods

mixed
resolveAttribute(string $attributeClass)

Resolve the nearest matching attribute in the class hierarchy.

from  ReadsAttributes
array
resolveAttributes(string $attributeClass)

Resolve all matching attributes in the class hierarchy.

from  ReadsAttributes
static void
flushState()

Flush all static state.

from  ReadsAttributes
array
resolvedIcons()

Resolve icons from attributes and the primitive's icons method.

from  HasIcons
void
setMeta(array|string $meta, mixed $value = null)

Set response metadata using an array or key-value pair.

from  HasMeta
array
mergeMeta(array $baseArray)

Merge metadata into the given response array.

from  HasMeta
string
name()

Get the primitive name.

string
title()

Get the primitive title.

string
description()

Get the primitive description.

array|null
meta()

Get the primitive metadata.

array
icons()

Get the primitive icons.

array
mergeIcons(array $baseArray)

Merge the resolved icons into the primitive array.

bool
eligibleForRegistration()

Determine whether the primitive may be registered for this request.

array
toMethodCall()

Convert the primitive to its method call representation.

array
toArray()

Convert the primitive to an array.

Details

in ReadsAttributes at line 24
protected mixed resolveAttribute(string $attributeClass)

Resolve the nearest matching attribute in the class hierarchy.

Parameters

string $attributeClass

Return Value

mixed

in ReadsAttributes at line 56
protected array resolveAttributes(string $attributeClass)

Resolve all matching attributes in the class hierarchy.

Parameters

string $attributeClass

Return Value

array

in ReadsAttributes at line 82
static void flushState()

Flush all static state.

Return Value

void

in HasIcons at line 19
array resolvedIcons()

Resolve icons from attributes and the primitive's icons method.

Return Value

array

in HasMeta at line 21
void setMeta(array|string $meta, mixed $value = null)

Set response metadata using an array or key-value pair.

Parameters

array|string $meta
mixed $value

Return Value

void

in HasMeta at line 46
array mergeMeta(array $baseArray)

Merge metadata into the given response array.

Parameters

array $baseArray

Return Value

array

at line 34
string name()

Get the primitive name.

Return Value

string

at line 44
string title()

Get the primitive title.

Return Value

string

at line 54
string description()

Get the primitive description.

Return Value

string

at line 66
array|null meta()

Get the primitive metadata.

Return Value

array|null

at line 76
array icons()

Get the primitive icons.

Return Value

array

at line 89
protected array mergeIcons(array $baseArray)

Merge the resolved icons into the primitive array.

Parameters

array $baseArray

Return Value

array

at line 103
bool eligibleForRegistration()

Determine whether the primitive may be registered for this request.

Return Value

bool

at line 117
abstract array toMethodCall()

Convert the primitive to its method call representation.

Return Value

array

at line 124
abstract array toArray()

Convert the primitive to an array.

Return Value

array