vendor/sensio/framework-extra-bundle/src/Configuration/ParamConverter.php line 20

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Sensio\Bundle\FrameworkExtraBundle\Configuration;
  14. /**
  15.  * The ParamConverter class handles the ParamConverter annotation parts.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  * @Annotation
  19.  */
  20. class ParamConverter extends ConfigurationAnnotation
  21. {
  22.     /**
  23.      * The parameter name.
  24.      *
  25.      * @var string
  26.      */
  27.     private $name;
  29.     /**
  30.      * The parameter class.
  31.      *
  32.      * @var string
  33.      */
  34.     private $class;
  36.     /**
  37.      * An array of options.
  38.      *
  39.      * @var array
  40.      */
  41.     private $options = [];
  43.     /**
  44.      * Whether or not the parameter is optional.
  45.      *
  46.      * @var bool
  47.      */
  48.     private $isOptional = false;
  50.     /**
  51.      * Use explicitly named converter instead of iterating by priorities.
  52.      *
  53.      * @var string
  54.      */
  55.     private $converter;
  57.     /**
  58.      * Returns the parameter name.
  59.      *
  60.      * @return string
  61.      */
  62.     public function getName()
  63.     {
  64.         return $this->name;
  65.     }
  67.     /**
  68.      * Sets the parameter name.
  69.      *
  70.      * @param string $name The parameter name
  71.      */
  72.     public function setValue($name)
  73.     {
  74.         $this->setName($name);
  75.     }
  77.     /**
  78.      * Sets the parameter name.
  79.      *
  80.      * @param string $name The parameter name
  81.      */
  82.     public function setName($name)
  83.     {
  84.         $this->name = $name;
  85.     }
  87.     /**
  88.      * Returns the parameter class name.
  89.      *
  90.      * @return string $name
  91.      */
  92.     public function getClass()
  93.     {
  94.         return $this->class;
  95.     }
  97.     /**
  98.      * Sets the parameter class name.
  99.      *
  100.      * @param string $class The parameter class name
  101.      */
  102.     public function setClass($class)
  103.     {
  104.         $this->class = $class;
  105.     }
  107.     /**
  108.      * Returns an array of options.
  109.      *
  110.      * @return array
  111.      */
  112.     public function getOptions()
  113.     {
  114.         return $this->options;
  115.     }
  117.     /**
  118.      * Sets an array of options.
  119.      *
  120.      * @param array $options An array of options
  121.      */
  122.     public function setOptions($options)
  123.     {
  124.         $this->options = $options;
  125.     }
  127.     /**
  128.      * Sets whether or not the parameter is optional.
  129.      *
  130.      * @param bool $optional Whether the parameter is optional
  131.      */
  132.     public function setIsOptional($optional)
  133.     {
  134.         $this->isOptional = (bool) $optional;
  135.     }
  137.     /**
  138.      * Returns whether or not the parameter is optional.
  139.      *
  140.      * @return bool
  141.      */
  142.     public function isOptional()
  143.     {
  144.         return $this->isOptional;
  145.     }
  147.     /**
  148.      * Get explicit converter name.
  149.      *
  150.      * @return string
  151.      */
  152.     public function getConverter()
  153.     {
  154.         return $this->converter;
  155.     }
  157.     /**
  158.      * Set explicit converter name.
  159.      *
  160.      * @param string $converter
  161.      */
  162.     public function setConverter($converter)
  163.     {
  164.         $this->converter = $converter;
  165.     }
  167.     /**
  168.      * Returns the annotation alias name.
  169.      *
  170.      * @return string
  171.      *
  172.      * @see ConfigurationInterface
  173.      */
  174.     public function getAliasName()
  175.     {
  176.         return 'converters';
  177.     }
  179.     /**
  180.      * Multiple ParamConverters are allowed.
  181.      *
  182.      * @return bool
  183.      *
  184.      * @see ConfigurationInterface
  185.      */
  186.     public function allowArray()
  187.     {
  188.         return true;
  189.     }
  190. }