interface/modules/zend_modules/library/Zend/Code/Generator/DocBlock/Tag/LicenseTag.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 LicenseTag extends Tag
  16 {
  17     /**
  18      * @var string
  19      */
  20     protected $url = null;
  21
  22     /**
  23      * @var string
  24      */
  25     protected $licenseName = null;
  26
  27     /**
  28      * @param  array $options
  29      */
  30     public function __construct(array $options = array())
  31     {
  32         parent::__construct($options);
  33
  34         if (isset($options['url'])) {
  35             $this->setUrl($options['url']);
  36         }
  37
  38         if (empty($this->name)) {
  39             $this->setName('license');
  40         }
  41     }
  42
  43     /**
  44      * @param  ReflectionDocBlockTag $reflectionTagLicense
  45      * @return LicenseTag
  46      */
  47     public static function fromReflection(ReflectionDocBlockTag $reflectionTagLicense)
  48     {
  49         $licenseTag = new static();
  50         $licenseTag
  51             ->setName('license')
  52             ->setUrl($reflectionTagLicense->getUrl())
  53             ->setLicenseName($reflectionTagLicense->getDescription());
  54
  55         return $licenseTag;
  56     }
  57
  58     /**
  59      * @param  string $url
  60      * @return LicenseTag
  61      */
  62     public function setUrl($url)
  63     {
  64         $this->url = $url;
  65         return $this;
  66     }
  67
  68     /**
  69      * @return string
  70      */
  71     public function getUrl()
  72     {
  73         return $this->url;
  74     }
  75
  76     /**
  77      * @param  string $name
  78      * @return LicenseTag
  79      */
  80     public function setLicenseName($name)
  81     {
  82         $this->licenseName = $name;
  83         return $this;
  84     }
  85
  86     /**
  87      * @return string
  88      */
  89     public function getLicenseName()
  90     {
  91         return $this->licenseName;
  92     }
  93
  94     /**
  95      * @return string
  96      */
  97     public function generate()
  98     {
  99         $output = '@license '
 100             . (($this->url != null) ? $this->url : 'unknown')
 101             . (($this->licenseName != null) ? ' ' . $this->licenseName : '')
 102             . (($this->description != null) ? ' ' . $this->description : '');
 103
 104         return $output;
 105     }
 106 }