interface/modules/zend_modules/library/Zend/Code/Reflection/DocBlock/TagManager.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\Reflection\DocBlock;
  11
  12 use Zend\Code\Reflection\DocBlock\Tag\GenericTag;
  13 use Zend\Code\Reflection\DocBlock\Tag\TagInterface;
  14 use Zend\Code\Reflection\Exception;
  15
  16 class TagManager
  17 {
  18     const USE_DEFAULT_PROTOTYPES = 'default';
  19
  20     /**
  21      * @var array
  22      */
  23     protected $tagNames = array();
  24
  25     /**
  26      * @var array
  27      */
  28     protected $tags = array();
  29
  30     /**
  31      * @var GenericTag
  32      */
  33     protected $genericTag = null;
  34
  35     /**
  36      * @param TagInterface[] $prototypes
  37      */
  38     public function __construct($prototypes = null)
  39     {
  40         if (is_array($prototypes)) {
  41             foreach ($prototypes as $prototype) {
  42                 $this->addTagPrototype($prototype);
  43             }
  44         } elseif ($prototypes === self::USE_DEFAULT_PROTOTYPES) {
  45             $this->useDefaultPrototypes();
  46         }
  47     }
  48
  49     /**
  50      * @return void
  51      */
  52     public function useDefaultPrototypes()
  53     {
  54         $this->addTagPrototype(new Tag\ParamTag());
  55         $this->addTagPrototype(new Tag\ReturnTag());
  56         $this->addTagPrototype(new Tag\MethodTag());
  57         $this->addTagPrototype(new Tag\PropertyTag());
  58         $this->addTagPrototype(new Tag\AuthorTag());
  59         $this->addTagPrototype(new Tag\LicenseTag());
  60         $this->addTagPrototype(new Tag\ThrowsTag());
  61         $this->addTagPrototype(new Tag\GenericTag());
  62     }
  63
  64     /**
  65      * @param TagInterface $tag
  66      * @throws Exception\InvalidArgumentException
  67      */
  68     public function addTagPrototype(TagInterface $tag)
  69     {
  70         $tagName = str_replace(array('-', '_'), '', $tag->getName());
  71
  72         if (in_array($tagName, $this->tagNames)) {
  73             throw new Exception\InvalidArgumentException('A tag with this name already exists in this manager');
  74         }
  75
  76         $this->tagNames[] = $tagName;
  77         $this->tags[]     = $tag;
  78
  79         if ($tag instanceof GenericTag) {
  80             $this->genericTag = $tag;
  81         }
  82     }
  83
  84     /**
  85      * @param  string $tagName
  86      * @return bool
  87      */
  88     public function hasTag($tagName)
  89     {
  90         // otherwise, only if its name exists as a key
  91         return in_array(str_replace(array('-', '_'), '', $tagName), $this->tagNames);
  92     }
  93
  94     /**
  95      * @param  string $tagName
  96      * @param  string $content
  97      * @return GenericTag
  98      * @throws Exception\RuntimeException
  99      */
 100     public function createTag($tagName, $content = null)
 101     {
 102         $tagName = str_replace(array('-', '_'), '', $tagName);
 103
 104         if (!$this->hasTag($tagName) && !isset($this->genericTag)) {
 105             throw new Exception\RuntimeException('This tag name is not supported by this tag manager');
 106         }
 107
 108         $index = array_search($tagName, $this->tagNames);
 109
 110         /* @var TagInterface $tag */
 111         $tag = ($index !== false) ? $this->tags[$index] : $this->genericTag;
 112
 113         $newTag = clone $tag;
 114         if ($content) {
 115             $newTag->initialize($content);
 116         }
 117
 118         if ($newTag instanceof GenericTag) {
 119             $newTag->setName($tagName);
 120         }
 121
 122         return $newTag;
 123     }
 124 }