Repository navigation
Expand file tree
/
Copy pathAnnotation.php
More file actions
124 lines (110 loc) · 2.81 KB
/
Copy pathAnnotation.php
File metadata and controls
124 lines (110 loc) · 2.81 KB
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?php
namespace Codeception\Util;
/**
* Simple annotation parser. Take only key-value annotations for methods or class.
*/
class Annotation
{
protected static $reflectedClasses = [];
protected static $regex = '/@%s(?:[ \t]+(.*?))?[ \t]*\r?$/m';
protected static $lastReflected = null;
/**
* @var \ReflectionClass
*/
protected $reflectedClass;
protected $currentReflectedItem;
/**
* Grabs annotation values.
*
* Usage example:
*
* ``` php
* <?php
* Annotation::forClass('MyTestCase')->fetch('guy');
* Annotation::forClass('MyTestCase')->method('testData')->fetch('depends');
* Annotation::forClass('MyTestCase')->method('testData')->fetchAll('depends');
*
* ?>
* ```
*
* @param $class
*
* @return $this
*/
public static function forClass($class)
{
if (is_object($class)) {
$class = get_class($class);
}
if (!isset(static::$reflectedClasses[$class])) {
static::$reflectedClasses[$class] = new \ReflectionClass($class);
}
return new static(static::$reflectedClasses[$class]);
}
/**
* @param $class
* @param $method
*
* @return $this
*/
public static function forMethod($class, $method)
{
return self::forClass($class)->method($method);
}
/**
* Parses raw comment for annotations
*
* @param $comment
* @param $annotation
* @return array
*/
public static function fetchAllFromComment($annotation, $comment)
{
if (preg_match_all(sprintf(self::$regex, $annotation), $comment, $matched)) {
return $matched[1];
}
return [];
}
public function __construct(\ReflectionClass $class)
{
$this->currentReflectedItem = $this->reflectedClass = $class;
}
/**
* @param $method
*
* @return $this
*/
public function method($method)
{
$this->currentReflectedItem = $this->reflectedClass->getMethod($method);
return $this;
}
/**
* @param $annotation
* @return null
*/
public function fetch($annotation)
{
$docBlock = $this->currentReflectedItem->getDocComment();
if (preg_match(sprintf(self::$regex, $annotation), $docBlock, $matched)) {
return $matched[1];
}
return null;
}
/**
* @param $annotation
* @return array
*/
public function fetchAll($annotation)
{
$docBlock = $this->currentReflectedItem->getDocComment();
if (preg_match_all(sprintf(self::$regex, $annotation), $docBlock, $matched)) {
return $matched[1];
}
return [];
}
public function raw()
{
return $this->currentReflectedItem->getDocComment();
}
}