interface/modules/zend_modules/library/Zend/Code/Reflection/DocBlock/Tag/ReturnTag.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\Tag;
  11
  12 class ReturnTag implements TagInterface, PhpDocTypedTagInterface
  13 {
  14     /**
  15      * @var array
  16      */
  17     protected $types = array();
  18
  19     /**
  20      * @var string
  21      */
  22     protected $description = null;
  23
  24     /**
  25      * @return string
  26      */
  27     public function getName()
  28     {
  29         return 'return';
  30     }
  31
  32     /**
  33      * @param  string $tagDocBlockLine
  34      * @return void
  35      */
  36     public function initialize($tagDocBlockLine)
  37     {
  38         $matches = array();
  39         if (!preg_match('#((?:[\w|\\\]+(?:\[\])*\|?)+)(?:\s+(.*))?#s', $tagDocBlockLine, $matches)) {
  40             return;
  41         }
  42
  43         $this->types = explode('|', $matches[1]);
  44
  45         if (isset($matches[2])) {
  46             $this->description = trim(preg_replace('#\s+#', ' ', $matches[2]));
  47         }
  48     }
  49
  50     /**
  51      * @return string
  52      * @deprecated 2.0.4 use getTypes instead
  53      */
  54     public function getType()
  55     {
  56         if (empty($this->types)) {
  57             return '';
  58         }
  59
  60         return $this->types[0];
  61     }
  62
  63     public function getTypes()
  64     {
  65         return $this->types;
  66     }
  67
  68     /**
  69      * @return string
  70      */
  71     public function getDescription()
  72     {
  73         return $this->description;
  74     }
  75 }