# ParametersInterface

Chevere\Interfaces\Parameter\ParametersInterface

view source

# Extends

# Description

Describes the component in charge of collecting objects implementing ParameterInterface.

# Methods

# getGenerator()

RETURN

Generator

# withAddedRequired()

Return an instance with the specified required $parameters instance added.

# Parameters

ParameterInterface ...$parameters

THROWS

OverflowException

RETURN

self

This method MUST retain the state of the current instance, and return an instance that contains the specified required $parameters instance added.

# withAddedOptional()

Return an instance with the specified optional $parameters instance added.

# Parameters

ParameterInterface ...$parameters

THROWS

OverflowException

RETURN

self

This method MUST retain the state of the current instance, and return an instance that contains the specified optional $parameters instance added.

# withModify()

Return an instance with the specified $parameters modifying an already added parameter.

# Parameters

ParameterInterface ...$parameters

THROWS

OutOfBoundsException

RETURN

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $parameters modifying an already added parameter.

# has()

Indicates whether the instance has a parameter by name.

# Parameters

string $parameter

RETURN

bool

# isRequired()

Indicates whether the $parameter identified by its name is required.

# Parameters

string $parameter

THROWS

OutOfBoundsException

RETURN

bool

# isOptional()

Indicates whether the $parameter identified by its name is optional.

# Parameters

string $parameter

THROWS

OutOfBoundsException

RETURN

bool

# get()

# Parameters

string $parameter

THROWS

OutOfBoundsException

RETURN

ParameterInterface

# required()

RETURN

Ds\Set

# optional()

RETURN

Ds\Set

# keys()

Provides access to the object keys.

RETURN

array