interface/modules/zend_modules/library/Zend/Code/Reflection/FunctionReflection.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;
  11
  12 use ReflectionFunction;
  13 use Zend\Code\Reflection\DocBlock\Tag\ReturnTag;
  14
  15 class FunctionReflection extends ReflectionFunction implements ReflectionInterface
  16 {
  17     /**
  18      * Get function DocBlock
  19      *
  20      * @throws Exception\InvalidArgumentException
  21      * @return DocBlockReflection
  22      */
  23     public function getDocBlock()
  24     {
  25         if ('' == ($comment = $this->getDocComment())) {
  26             throw new Exception\InvalidArgumentException(sprintf(
  27                 '%s does not have a DocBlock',
  28                 $this->getName()
  29             ));
  30         }
  31
  32         $instance = new DocBlockReflection($comment);
  33
  34         return $instance;
  35     }
  36
  37     /**
  38      * Get start line (position) of function
  39      *
  40      * @param  bool $includeDocComment
  41      * @return int
  42      */
  43     public function getStartLine($includeDocComment = false)
  44     {
  45         if ($includeDocComment) {
  46             if ($this->getDocComment() != '') {
  47                 return $this->getDocBlock()->getStartLine();
  48             }
  49         }
  50
  51         return parent::getStartLine();
  52     }
  53
  54     /**
  55      * Get contents of function
  56      *
  57      * @param  bool $includeDocBlock
  58      * @return string
  59      */
  60     public function getContents($includeDocBlock = true)
  61     {
  62         return implode("\n",
  63             array_splice(
  64                 file($this->getFileName()),
  65                 $this->getStartLine($includeDocBlock),
  66                 ($this->getEndLine() - $this->getStartLine()),
  67                 true
  68             )
  69         );
  70     }
  71
  72     /**
  73      * Get function parameters
  74      *
  75      * @return ParameterReflection[]
  76      */
  77     public function getParameters()
  78     {
  79         $phpReflections  = parent::getParameters();
  80         $zendReflections = array();
  81         while ($phpReflections && ($phpReflection = array_shift($phpReflections))) {
  82             $instance          = new ParameterReflection($this->getName(), $phpReflection->getName());
  83             $zendReflections[] = $instance;
  84             unset($phpReflection);
  85         }
  86         unset($phpReflections);
  87
  88         return $zendReflections;
  89     }
  90
  91     /**
  92      * Get return type tag
  93      *
  94      * @throws Exception\InvalidArgumentException
  95      * @return ReturnTag
  96      */
  97     public function getReturn()
  98     {
  99         $docBlock = $this->getDocBlock();
 100         if (!$docBlock->hasTag('return')) {
 101             throw new Exception\InvalidArgumentException(
 102                 'Function does not specify an @return annotation tag; cannot determine return type'
 103             );
 104         }
 105
 106         $tag    = $docBlock->getTag('return');
 107         return new DocBlockReflection('@return ' . $tag->getDescription());
 108     }
 109
 110     public function toString()
 111     {
 112         return $this->__toString();
 113     }
 114
 115     /**
 116      * Required due to bug in php
 117      *
 118      * @return string
 119      */
 120     public function __toString()
 121     {
 122         return parent::__toString();
 123     }
 124 }