Codeception/src/Codeception/Util/Annotation.php at 1.8 · yesdevnull/Codeception · GitHub

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
<?php


namespace Codeception\Util;


class Annotation {

    protected static $reflectedClasses = array();
    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);
    }

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

    public function fetch($annotation)
    {
        $docBlock = $this->currentReflectedItem->getDocComment();
        $matched = array();
        $res = preg_match(sprintf(self::$regex, $annotation), $docBlock, $matched);
        if (!$res) return null;
        return $matched[1];
    }

    public function fetchAll($annotation)
    {
        $docBlock = $this->currentReflectedItem->getDocComment();
        $matched = array();
        $res = preg_match_all(sprintf(self::$regex, $annotation), $docBlock, $matched);
        if (!$res) return array();
        return $matched[1];
    }

}