ParamConverter
extends ConfigurationAnnotation
in package
The ParamConverter class handles the ParamConverter annotation parts.
Tags
Table of Contents
- $class : string
- The parameter class.
- $converter : string
- Use explicitly named converter instead of iterating by priorities.
- $isOptional : bool
- Whether or not the parameter is optional.
- $name : string
- The parameter name.
- $options : array<string|int, mixed>
- An array of options.
- __construct() : mixed
- allowArray() : bool
- Multiple ParamConverters are allowed.
- getAliasName() : string
- Returns the annotation alias name.
- getClass() : string
- Returns the parameter class name.
- getConverter() : string
- Get explicit converter name.
- getName() : string
- Returns the parameter name.
- getOptions() : array<string|int, mixed>
- Returns an array of options.
- isOptional() : bool
- Returns whether or not the parameter is optional.
- setClass() : mixed
- Sets the parameter class name.
- setConverter() : mixed
- Set explicit converter name.
- setIsOptional() : mixed
- Sets whether or not the parameter is optional.
- setName() : mixed
- Sets the parameter name.
- setOptions() : mixed
- Sets an array of options.
- setValue() : mixed
- Sets the parameter name.
Properties
$class
The parameter class.
private
string
$class
$converter
Use explicitly named converter instead of iterating by priorities.
private
string
$converter
$isOptional
Whether or not the parameter is optional.
private
bool
$isOptional
= false
$name
The parameter name.
private
string
$name
$options
An array of options.
private
array<string|int, mixed>
$options
= []
Methods
__construct()
public
__construct(array<string|int, mixed> $values) : mixed
Parameters
- $values : array<string|int, mixed>
Return values
mixed —allowArray()
Multiple ParamConverters are allowed.
public
allowArray() : bool
Tags
Return values
bool —getAliasName()
Returns the annotation alias name.
public
getAliasName() : string
Tags
Return values
string —getClass()
Returns the parameter class name.
public
getClass() : string
Return values
string —$name
getConverter()
Get explicit converter name.
public
getConverter() : string
Return values
string —getName()
Returns the parameter name.
public
getName() : string
Return values
string —getOptions()
Returns an array of options.
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —isOptional()
Returns whether or not the parameter is optional.
public
isOptional() : bool
Return values
bool —setClass()
Sets the parameter class name.
public
setClass(string $class) : mixed
Parameters
- $class : string
-
The parameter class name
Return values
mixed —setConverter()
Set explicit converter name.
public
setConverter(string $converter) : mixed
Parameters
- $converter : string
Return values
mixed —setIsOptional()
Sets whether or not the parameter is optional.
public
setIsOptional(bool $optional) : mixed
Parameters
- $optional : bool
-
Whether the parameter is optional
Return values
mixed —setName()
Sets the parameter name.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The parameter name
Return values
mixed —setOptions()
Sets an array of options.
public
setOptions(array<string|int, mixed> $options) : mixed
Parameters
- $options : array<string|int, mixed>
-
An array of options
Return values
mixed —setValue()
Sets the parameter name.
public
setValue(string $name) : mixed
Parameters
- $name : string
-
The parameter name