OCA\Music\AppFramework\Utility\MethodAnnotationReader

Complexity

Total Complexity

2

Size/Duplication

Total Lines	25
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	hasAnnotation()	0	2	1
A	__construct()	0	9	1

<?php
/**
 * ownCloud
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Alessandro Cosentino <cosenal@gmail.com>
 * @author Bernhard Posselt <dev@bernhard-posselt.com>
 * @copyright Alessandro Cosentino 2012
 * @copyright Bernhard Posselt 2012, 2014
 */

namespace OCA\Music\AppFramework\Utility;

/**
 * Reads and parses annotations from doc comments
 */
class MethodAnnotationReader {
	private $annotations;

	/**
	 * @param object|string $object an object or classname
	 * @param string $method the method which we want to inspect for annotations
	 */
	public function __construct($object, $method) {
		$this->annotations = [];

		$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);
	}
}