interface/modules/zend_modules/library/Zend/Code/Generator/DocBlock/Tag/AuthorTag.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Code\Generator\DocBlock\Tag;
  11
  12 use Zend\Code\Generator\DocBlock\Tag;
  13 use Zend\Code\Reflection\DocBlock\Tag\TagInterface as ReflectionDocBlockTag;
  14
  15 class AuthorTag extends Tag
  16 {
  17     /**
  18      * @var string
  19      */
  20     protected $datatype = null;
  21
  22     /**
  23      * @var string
  24      */
  25     protected $paramName = null;
  26
  27     /**
  28      * @param  ReflectionDocBlockTag $reflectionTagParam
  29      * @return AuthorTag
  30      */
  31     public static function fromReflection(ReflectionDocBlockTag $reflectionTagParam)
  32     {
  33         $authorTag = new self();
  34         $authorTag
  35             ->setName('author')
  36             ->setAuthorName($reflectionTagParam->getType()) // @todo rename
  37             ->setAuthorEmail($reflectionTagParam->getVariableName())
  38             ->setDescription($reflectionTagParam->getDescription());
  39
  40         return $authorTag;
  41     }
  42
  43     /**
  44      * @param  string $datatype
  45      * @return AuthorTag
  46      */
  47     public function setDatatype($datatype)
  48     {
  49         $this->datatype = (string) $datatype;
  50         return $this;
  51     }
  52
  53     /**
  54      * @return string
  55      */
  56     public function getDatatype()
  57     {
  58         return $this->datatype;
  59     }
  60
  61     /**
  62      * @param  string $paramName
  63      * @return AuthorTag
  64      */
  65     public function setParamName($paramName)
  66     {
  67         $this->paramName = (string) $paramName;
  68         return $this;
  69     }
  70
  71     /**
  72      * @return string
  73      */
  74     public function getParamName()
  75     {
  76         return $this->paramName;
  77     }
  78
  79     /**
  80      * @return string
  81      */
  82     public function generate()
  83     {
  84         $output = '@param '
  85             . (($this->datatype != null) ? $this->datatype : 'unknown')
  86             . (($this->paramName != null) ? ' $' . $this->paramName : '')
  87             . (($this->description != null) ? ' ' . $this->description : '');
  88
  89         return $output;
  90     }
  91
  92 }