Blame view

sources/lib/private/appframework/utility/methodannotationreader.php 1.63 KB
31b7f2792   Kload   Upgrade to ownclo...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
  <?php
  
  /**
   * ownCloud - App Framework
   *
   * @author Bernhard Posselt
   * @copyright 2012 Bernhard Posselt nukeawhale@gmail.com
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  
  namespace OC\AppFramework\Utility;
  
  
  /**
   * Reads and parses annotations from doc comments
   */
  class MethodAnnotationReader {
  
  	private $annotations;
  
  	/**
  	 * @param object $object an object or classname
  	 * @param string $method the method which we want to inspect for annotations
  	 */
  	public function __construct($object, $method){
  		$this->annotations = array();
  
  		$reflection = new \ReflectionMethod($object, $method);
  		$docs = $reflection->getDocComment();
  
  		// extract everything prefixed by @ and first letter uppercase
  		preg_match_all('/@([A-Z]\w+)/', $docs, $matches);
  		$this->annotations = $matches[1];
  	}
  
  
  	/**
  	 * Check if a method contains an annotation
  	 * @param string $name the name of the annotation
  	 * @return bool true if the annotation is found
  	 */
  	public function hasAnnotation($name){
  		return in_array($name, $this->annotations);
  	}
  
  
  }