kekrozsak/vendor/sensio/framework-extra-bundle/Sensio/Bundle/FrameworkExtraBundle/Configuration/ParamConverter.php
Polonkai Gergely 082a0130c2 Initial commit with Symfony 2.1+Vendors
Signed-off-by: Gergely POLONKAI (W00d5t0ck) <polesz@w00d5t0ck.info>
2012-07-01 09:52:20 +02:00

153 lines
2.8 KiB
PHP

<?php
namespace Sensio\Bundle\FrameworkExtraBundle\Configuration;
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* The ParamConverter class handles the @ParamConverter annotation parts.
*
* @ParamConverter("post", class="BlogBundle:Post")
*
* @author Fabien Potencier <fabien@symfony.com>
* @Annotation
*/
class ParamConverter extends ConfigurationAnnotation
{
/**
* The parameter name.
*
* @var string
*/
protected $name;
/**
* The parameter class.
*
* @var string
*/
protected $class;
/**
* An array of options.
*
* @var array
*/
protected $options = array();
/**
* Whether or not the parameter is optional.
*
* @var Boolean
*/
protected $optional = false;
/**
* Returns the parameter name.
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Sets the parameter name.
*
* @param string $name The parameter name
*/
public function setValue($name)
{
$this->setName($name);
}
/**
* Sets the parameter name.
*
* @param string $name The parameter name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* Returns the parameter class name.
*
* @return string $name
*/
public function getClass()
{
return $this->class;
}
/**
* Sets the parameter class name.
*
* @param string $class The parameter class name
*/
public function setClass($class)
{
$this->class = $class;
}
/**
* Returns an array of options.
*
* @return array
*/
public function getOptions()
{
return $this->options;
}
/**
* Sets an array of options.
*
* @param array $options An array of options
*/
public function setOptions($options)
{
$this->options = $options;
}
/**
* Sets whether or not the parameter is optional.
*
* @param Boolean $optional Wether the parameter is optional
*/
public function setIsOptional($optional)
{
$this->optional = (Boolean) $optional;
}
/**
* Returns whether or not the parameter is optional.
*
* @return Boolean
*/
public function isOptional()
{
return $this->optional;
}
/**
* Returns the annotation alias name.
*
* @return string
* @see ConfigurationInterface
*/
public function getAliasName()
{
return 'converters';
}
}