ApiPlatform\Metadata\Parameters

A parameter dictionnary.

class ApiPlatform\Metadata\Parameters implements IteratorAggregate, Countable, Traversable
{
    public __construct(array<string, ApiPlatform\Metadata\Parameter> $parameters)
    public getIterator(): array&lt;string, ApiPlatform\Metadata\Parameter&gt;
    public add(string $key, $value): `<a href="/docs/main/references/Metadata/Parameters">ApiPlatform\Metadata\Parameters
    public get(string $key): ApiPlatform\Metadata\Parameter
    public remove(string $key): ApiPlatform\Metadata\Parameters
    public has(string $key): bool
    public count(): int
    public sort(): ApiPlatform\Metadata\Parameters
}

Methods

__construct

public __construct(array<string, ApiPlatform\Metadata\Parameter> $parameters)

Parameters

parameters

array<string, `ApiPlatform\Metadata\Parameter`>

getIterator

public getIterator(): array&lt;string, ApiPlatform\Metadata\Parameter&gt;

Returns

array<string, <a href="/docs/main/references/Metadata/Parameter">ApiPlatform\Metadata\Parameter</a>>

add

public add(string $key, $value): `<a href="/docs/main/references/Metadata/Parameters">ApiPlatform\Metadata\Parameters

Parameters

key	string
value	`ApiPlatform\Metadata\Parameter`

Returns

<a href="/docs/main/references/Metadata/Parameters">ApiPlatform\Metadata\Parameters</a>

get

public get(string $key): ApiPlatform\Metadata\Parameter

Parameters

key

string

Returns

<a href="/docs/main/references/Metadata/Parameter">ApiPlatform\Metadata\Parameter</a>

remove

public remove(string $key): ApiPlatform\Metadata\Parameters

Parameters

key

string

Returns

<a href="/docs/main/references/Metadata/Parameters">ApiPlatform\Metadata\Parameters</a>

has

public has(string $key): bool

Parameters

key

string

Returns

bool

count

public count(): int

Returns

int

sort

public sort(): ApiPlatform\Metadata\Parameters

Returns

<a href="/docs/main/references/Metadata/Parameters">ApiPlatform\Metadata\Parameters</a>