interface/modules/zend_modules/library/Zend/Code/Scanner/PropertyScanner.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\Scanner;
  11
  12 use Zend\Code\Annotation;
  13 use Zend\Code\Exception;
  14 use Zend\Code\NameInformation;
  15
  16 class PropertyScanner implements ScannerInterface
  17 {
  18     /**
  19      * @var bool
  20      */
  21     protected $isScanned = false;
  22
  23     /**
  24      * @var array
  25      */
  26     protected $tokens;
  27
  28     /**
  29      * @var NameInformation
  30      */
  31     protected $nameInformation;
  32
  33     /**
  34      * @var string
  35      */
  36     protected $class;
  37
  38     /**
  39      * @var ClassScanner
  40      */
  41     protected $scannerClass;
  42
  43     /**
  44      * @var int
  45      */
  46     protected $lineStart;
  47
  48     /**
  49      * @var bool
  50      */
  51     protected $isProtected = false;
  52
  53     /**
  54      * @var bool
  55      */
  56     protected $isPublic = true;
  57
  58     /**
  59      * @var bool
  60      */
  61     protected $isPrivate = false;
  62
  63     /**
  64      * @var bool
  65      */
  66     protected $isStatic = false;
  67
  68     /**
  69      * @var string
  70      */
  71     protected $docComment;
  72
  73     /**
  74      * @var string
  75      */
  76     protected $name;
  77
  78     /**
  79      * @var string
  80      */
  81     protected $value;
  82
  83     /**
  84      * Constructor
  85      *
  86      * @param array $propertyTokens
  87      * @param NameInformation $nameInformation
  88      */
  89     public function __construct(array $propertyTokens, NameInformation $nameInformation = null)
  90     {
  91         $this->tokens = $propertyTokens;
  92         $this->nameInformation = $nameInformation;
  93     }
  94
  95     /**
  96      * @param string $class
  97      */
  98     public function setClass($class)
  99     {
 100         $this->class = $class;
 101     }
 102
 103     /**
 104      * @param ClassScanner $scannerClass
 105      */
 106     public function setScannerClass(ClassScanner $scannerClass)
 107     {
 108         $this->scannerClass = $scannerClass;
 109     }
 110
 111     /**
 112      * @return ClassScanner
 113      */
 114     public function getClassScanner()
 115     {
 116         return $this->scannerClass;
 117     }
 118
 119     /**
 120      * @return string
 121      */
 122     public function getName()
 123     {
 124         $this->scan();
 125         return $this->name;
 126     }
 127
 128     /**
 129      * @return bool
 130      */
 131     public function isPublic()
 132     {
 133         $this->scan();
 134         return $this->isPublic;
 135     }
 136
 137     /**
 138      * @return bool
 139      */
 140     public function isPrivate()
 141     {
 142         $this->scan();
 143         return $this->isPrivate;
 144     }
 145
 146     /**
 147      * @return bool
 148      */
 149     public function isProtected()
 150     {
 151         $this->scan();
 152         return $this->isProtected;
 153     }
 154
 155     /**
 156      * @return bool
 157      */
 158     public function isStatic()
 159     {
 160         $this->scan();
 161         return $this->isStatic;
 162     }
 163
 164     /**
 165      * @return string
 166      */
 167     public function getValue()
 168     {
 169         $this->scan();
 170         return $this->value;
 171     }
 172
 173     /**
 174      * @return string
 175      */
 176     public function getDocComment()
 177     {
 178         $this->scan();
 179         return $this->docComment;
 180     }
 181
 182     /**
 183      * @param Annotation\AnnotationManager $annotationManager
 184      * @return AnnotationScanner
 185      */
 186     public function getAnnotations(Annotation\AnnotationManager $annotationManager)
 187     {
 188         if (($docComment = $this->getDocComment()) == '') {
 189             return false;
 190         }
 191
 192         return new AnnotationScanner($annotationManager, $docComment, $this->nameInformation);
 193     }
 194
 195     /**
 196      * @return string
 197      */
 198     public function __toString()
 199     {
 200         $this->scan();
 201         return var_export($this, true);
 202     }
 203
 204     /**
 205      * Scan tokens
 206      *
 207      * @throws \Zend\Code\Exception\RuntimeException
 208      */
 209     protected function scan()
 210     {
 211         if ($this->isScanned) {
 212             return;
 213         }
 214
 215         if (!$this->tokens) {
 216             throw new Exception\RuntimeException('No tokens were provided');
 217         }
 218
 219         /**
 220          * Variables & Setup
 221          */
 222         $tokens = &$this->tokens;
 223
 224         reset($tokens);
 225
 226         SCANNER_TOP:
 227
 228         $token = current($tokens);
 229
 230         if (!is_string($token)) {
 231             list($tokenType, $tokenContent, $tokenLine) = $token;
 232
 233             switch ($tokenType) {
 234                 case T_DOC_COMMENT:
 235                     if ($this->docComment === null && $this->name === null) {
 236                         $this->docComment = $tokenContent;
 237                     }
 238                     goto SCANNER_CONTINUE;
 239
 240                 case T_VARIABLE:
 241                     $this->name = ltrim($tokenContent, '$');
 242                     goto SCANNER_CONTINUE;
 243
 244                 case T_PUBLIC:
 245                     // use defaults
 246                     goto SCANNER_CONTINUE;
 247
 248                 case T_PROTECTED:
 249                     $this->isProtected = true;
 250                     $this->isPublic = false;
 251                     goto SCANNER_CONTINUE;
 252
 253                 case T_PRIVATE:
 254                     $this->isPrivate = true;
 255                     $this->isPublic = false;
 256                     goto SCANNER_CONTINUE;
 257
 258                 case T_STATIC:
 259                     $this->isStatic = true;
 260                     goto SCANNER_CONTINUE;
 261
 262                 default:
 263                     if ($this->name !== null && trim($tokenContent) !== '') {
 264                         $this->value .= (is_string($token)) ? $token : $tokenContent;
 265                         if (substr($this->value, 0, 1) === '"' || substr($this->value, 0, 1) === "'") {
 266                             $this->value = substr($this->value, 1, -1); // Remove quotes
 267                         }
 268                     }
 269                     goto SCANNER_CONTINUE;
 270             }
 271         }
 272
 273         SCANNER_CONTINUE:
 274
 275         if (next($this->tokens) === false) {
 276             goto SCANNER_END;
 277         }
 278         goto SCANNER_TOP;
 279
 280         SCANNER_END:
 281
 282         $this->isScanned = true;
 283     }
 284 }