final class Metadata implements Countable, IteratorAggregate

Constants

internal OWNED_KEYS

Methods

static Metadata
make(array $values = [])

Create metadata from raw application values.

with(string $key, string ...$values)

Append values to a metadata key.

without(string $key)

Remove a metadata key.

merge(Metadata|array $metadata)

Append another metadata collection.

string|null
first(string $key, string|null $default = null)

Return the first value for a metadata key.

array
values(string $key)

Return every value for a metadata key.

bool
has(string $key)

Determine whether a metadata key exists.

bool
isEmpty()

Determine whether the collection is empty.

array
all()

Return every metadata value.

int
count()

Count the metadata keys.

getIterator()

Return an iterator over the metadata keys and values.

Details

at line 49
static Metadata make(array $values = [])

Create metadata from raw application values.

Parameters

array $values

Return Value

Metadata

at line 81
Metadata with(string $key, string ...$values)

Append values to a metadata key.

Parameters

string $key
string ...$values

Return Value

Metadata

at line 101
Metadata without(string $key)

Remove a metadata key.

Parameters

string $key

Return Value

Metadata

at line 120
Metadata merge(Metadata|array $metadata)

Append another metadata collection.

Parameters

Metadata|array $metadata

Return Value

Metadata

at line 137
string|null first(string $key, string|null $default = null)

Return the first value for a metadata key.

Parameters

string $key
string|null $default

Return Value

string|null

at line 149
array values(string $key)

Return every value for a metadata key.

Parameters

string $key

Return Value

array

at line 159
bool has(string $key)

Determine whether a metadata key exists.

Parameters

string $key

Return Value

bool

at line 167
bool isEmpty()

Determine whether the collection is empty.

Return Value

bool

at line 177
array all()

Return every metadata value.

Return Value

array

at line 185
int count()

Count the metadata keys.

Return Value

int

at line 195
Traversable getIterator()

Return an iterator over the metadata keys and values.

Return Value

Traversable