# ArgumentsInterface
Chevere\Interfaces\Parameter\ArgumentsInterface
# Extends
# Description
Describes the component in charge of defining a set of parameters with arguments.
# Methods
# __construct()
# Parameters
- ParametersInterface
$parameters
- mixed
...$namedArguments
THROWS
- ⚠ Unknown type
ArgumentRequiredException
declared in@throws
tag` - OutOfBoundsException
- InvalidArgumentException
# parameters()
Provides access to the parameters instance.
RETURN
# toArray()
Provides access to the controller arguments as array.
RETURN
array
return [
'parameterName' => 'argument',
];
# withArgument()
Return an instance with the specified controller argument.
# Parameters
- string
$name
$value
THROWS
- ⚠ Unknown type
ArgumentValueRegexMatchException
declared in@throws
tag` - OutOfBoundsException If
$name
is not a known controller parameter.
RETURN
self
This method MUST retain the state of the current instance, and return an instance that contains the specified controller argument.
# has()
Indicates whether the instance has an argument for the parameter $name
.
# Parameters
- string
$name
RETURN
bool
# get()
Provides access to the argument value for the parameter $name
.
# Parameters
- string
$name
THROWS
RETURN
void
# getBoolean()
Provides access to the argument value for the parameter $boolean
type-hinted as boolean.
# Parameters
- string
$boolean
THROWS
RETURN
bool
# getString()
Provides access to the argument value for the parameter $string
type-hinted as string.
# Parameters
- string
$string
THROWS
RETURN
string
# getInteger()
Provides access to the argument value for the parameter $integer
type-hinted as integer.
# Parameters
- string
$integer
THROWS
RETURN
int
# getFloat()
Provides access to the argument value for the parameter $float
type-hinted as float.
# Parameters
- string
$float
THROWS
RETURN
float
# getArray()
Provides access to the argument value for the parameter $array
type-hinted as array.
# Parameters
- string
$array
THROWS
RETURN
array