interface/modules/zend_modules/library/Zend/Code/Reflection/MethodReflection.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 ReflectionMethod as PhpReflectionMethod;
  13 use Zend\Code\Annotation\AnnotationManager;
  14 use Zend\Code\Scanner\AnnotationScanner;
  15 use Zend\Code\Scanner\CachingFileScanner;
  16
  17 class MethodReflection extends PhpReflectionMethod implements ReflectionInterface
  18 {
  19     /**
  20      * @var AnnotationScanner
  21      */
  22     protected $annotations = null;
  23
  24     /**
  25      * Retrieve method DocBlock reflection
  26      *
  27      * @return DocBlockReflection|false
  28      */
  29     public function getDocBlock()
  30     {
  31         if ('' == $this->getDocComment()) {
  32             return false;
  33         }
  34
  35         $instance = new DocBlockReflection($this);
  36
  37         return $instance;
  38     }
  39
  40     /**
  41      * @param  AnnotationManager $annotationManager
  42      * @return AnnotationScanner
  43      */
  44     public function getAnnotations(AnnotationManager $annotationManager)
  45     {
  46         if (($docComment = $this->getDocComment()) == '') {
  47             return false;
  48         }
  49
  50         if ($this->annotations) {
  51             return $this->annotations;
  52         }
  53
  54         $cachingFileScanner = $this->createFileScanner($this->getFileName());
  55         $nameInformation    = $cachingFileScanner->getClassNameInformation($this->getDeclaringClass()->getName());
  56
  57         if (!$nameInformation) {
  58             return false;
  59         }
  60
  61         $this->annotations = new AnnotationScanner($annotationManager, $docComment, $nameInformation);
  62
  63         return $this->annotations;
  64     }
  65
  66     /**
  67      * Get start line (position) of method
  68      *
  69      * @param  bool $includeDocComment
  70      * @return int
  71      */
  72     public function getStartLine($includeDocComment = false)
  73     {
  74         if ($includeDocComment) {
  75             if ($this->getDocComment() != '') {
  76                 return $this->getDocBlock()->getStartLine();
  77             }
  78         }
  79
  80         return parent::getStartLine();
  81     }
  82
  83     /**
  84      * Get reflection of declaring class
  85      *
  86      * @return ClassReflection
  87      */
  88     public function getDeclaringClass()
  89     {
  90         $phpReflection  = parent::getDeclaringClass();
  91         $zendReflection = new ClassReflection($phpReflection->getName());
  92         unset($phpReflection);
  93
  94         return $zendReflection;
  95     }
  96
  97     /**
  98      * Get all method parameter reflection objects
  99      *
 100      * @return ParameterReflection[]
 101      */
 102     public function getParameters()
 103     {
 104         $phpReflections  = parent::getParameters();
 105         $zendReflections = array();
 106         while ($phpReflections && ($phpReflection = array_shift($phpReflections))) {
 107             $instance = new ParameterReflection(array(
 108                 $this->getDeclaringClass()->getName(),
 109                 $this->getName()),
 110                 $phpReflection->getName()
 111             );
 112             $zendReflections[] = $instance;
 113             unset($phpReflection);
 114         }
 115         unset($phpReflections);
 116
 117         return $zendReflections;
 118     }
 119
 120     /**
 121      * Get method contents
 122      *
 123      * @param  bool $includeDocBlock
 124      * @return string
 125      */
 126     public function getContents($includeDocBlock = true)
 127     {
 128         $fileContents = file($this->getFileName());
 129         $startNum     = $this->getStartLine($includeDocBlock);
 130         $endNum       = ($this->getEndLine() - $this->getStartLine());
 131
 132         return implode("\n", array_splice($fileContents, $startNum, $endNum, true));
 133     }
 134
 135     /**
 136      * Get method body
 137      *
 138      * @return string
 139      */
 140     public function getBody()
 141     {
 142         $lines = array_slice(
 143             file($this->getDeclaringClass()->getFileName(), FILE_IGNORE_NEW_LINES),
 144             $this->getStartLine(),
 145             ($this->getEndLine() - $this->getStartLine()),
 146             true
 147         );
 148
 149         $firstLine = array_shift($lines);
 150
 151         if (trim($firstLine) !== '{') {
 152             array_unshift($lines, $firstLine);
 153         }
 154
 155         $lastLine = array_pop($lines);
 156
 157         if (trim($lastLine) !== '}') {
 158             array_push($lines, $lastLine);
 159         }
 160
 161         // just in case we had code on the bracket lines
 162         return rtrim(ltrim(implode("\n", $lines), '{'), '}');
 163     }
 164
 165     public function toString()
 166     {
 167         return parent::__toString();
 168     }
 169
 170     public function __toString()
 171     {
 172         return parent::__toString();
 173     }
 174
 175     /**
 176      * Creates a new FileScanner instance.
 177      *
 178      * By having this as a seperate method it allows the method to be overridden
 179      * if a different FileScanner is needed.
 180      *
 181      * @param  string $filename
 182      *
 183      * @return FileScanner
 184      */
 185     protected function createFileScanner($filename)
 186     {
 187         return new CachingFileScanner($filename);
 188     }
 189 }