# ParametersInterface

Chevere\Interfaces\Parameter\ParametersInterface

view source (opens new window)

# Extends

# Description

Describes the component in charge of collecting objects implementing ParameterInterface.

# Methods

# __construct

Parameters

...parameters: ParameterInterface

# getGenerator

Return

Generator (opens new window)

# withAdded

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

Parameters

...parameters: ParameterInterface

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

...parameters: ParameterInterface

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

...parameters: ParameterInterface

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

parameter: string

Return

bool

# isRequired

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

Parameters

parameter: string

Throws

OutOfBoundsException

Return

bool

# isOptional

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

Parameters

parameter: string

Throws

OutOfBoundsException

Return

bool

# get

Parameters

parameter: string

Throws

OutOfBoundsException

Return

ParameterInterface

# required

Return

Ds\Set (opens new window)

# optional

Return

Ds\Set (opens new window)

# keys

Provides access to the object keys.

Return

array