Source of file ParamTag.php
Size: 3,123 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Code/Generator/DocBlock/Tag/ParamTag.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Code\Generator\DocBlock\Tag; use Zend\Code\Generator\DocBlock\TagManager; use Zend\Code\Reflection\DocBlock\Tag\TagInterface as ReflectionTagInterface; class ParamTag extends AbstractTypeableTag implements TagInterface { /** * @var string */ protected $variableName = null; /** * @param string $variableName * @param array $types * @param string $description */ public function __construct($variableName = null, $types = array(), $description = null) { if (!empty($variableName)) { $this->setVariableName($variableName); } parent::__construct($types, $description); } /** * @param ReflectionTagInterface $reflectionTag * @return ReturnTag * @deprecated Deprecated in 2.3. Use TagManager::createTagFromReflection() instead */ public static function fromReflection(ReflectionTagInterface $reflectionTag) { $tagManager = new TagManager(); $tagManager->initializeDefaultTags(); return $tagManager->createTagFromReflection($reflectionTag); } /** * @return string */ public function getName() { return 'param'; } /** * @param string $variableName * @return ParamTag */ public function setVariableName($variableName) { $this->variableName = ltrim($variableName, '$'); return $this; } /** * @return string */ public function getVariableName() { return $this->variableName; } /** * @param string $datatype * @return ReturnTag * @deprecated Deprecated in 2.3. Use setTypes() instead */ public function setDatatype($datatype) { return $this->setTypes($datatype); } /** * @return string * @deprecated Deprecated in 2.3. Use getTypes() or getTypesAsString() instead */ public function getDatatype() { return $this->getTypesAsString(); } /** * @param string $paramName * @return ParamTag * @deprecated Deprecated in 2.3. Use setVariableName() instead */ public function setParamName($paramName) { return $this->setVariableName($paramName); } /** * @return string * @deprecated Deprecated in 2.3. Use getVariableName() instead */ public function getParamName() { return $this->getVariableName(); } /** * @return string */ public function generate() { $output = '@param' . ((!empty($this->types)) ? ' ' . $this->getTypesAsString() : '') . ((!empty($this->variableName)) ? ' $' . $this->variableName : '') . ((!empty($this->description)) ? ' ' . $this->description : ''); return $output; } } |