Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter
The ParamConverter class handles the @ParamConverter annotation parts.
- Author: Fabien Potencier <fabien@symfony.com>
Synopsis
class ParamConverter
extends ConfigurationAnnotation
{
- // members
- protected string $name;
- protected string $class;
- protected array $options;
- protected Boolean $optional;
- protected string $converter;
- // methods
- public string getName()
- public void setValue()
- public void setName()
- public string getClass()
- public void setClass()
- public array getOptions()
- public void setOptions()
- public void setIsOptional()
- public Boolean isOptional()
- public string getConverter()
- public void setConverter()
- public string getAliasName()
- public Boolean allowArray()
- // Inherited methods from ConfigurationAnnotation
- public void __construct()
Hierarchy
Members
protected
- $class
—
string
The parameter class. - $converter
—
string
Use explicitly named converter instead of iterating by priorities. - $name
—
string
The parameter name. - $optional
—
Sensio\Bundle\FrameworkExtraBundle\Configuration\Boolean
Whether or not the parameter is optional. - $options
—
array
An array of options.
Methods
public
- allowArray() — Multiple ParamConverters are allowed
- getAliasName() — Returns the annotation alias name.
- getClass() — Returns the parameter class name.
- getConverter() — Get explicit converter name.
- getName() — Returns the parameter name.
- getOptions() — Returns an array of options.
- isOptional() — Returns whether or not the parameter is optional.
- setClass() — Sets the parameter class name.
- setConverter() — Set explicit converter name
- setIsOptional() — Sets whether or not the parameter is optional.
- setName() — Sets the parameter name.
- setOptions() — Sets an array of options.
- setValue() — Sets the parameter name.