|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* It's free open-source software released under the MIT License. |
|
5
|
|
|
* |
|
6
|
|
|
* @author Anatoly Nekhay <[email protected]> |
|
7
|
|
|
* @copyright Copyright (c) 2021, Anatoly Nekhay |
|
8
|
|
|
* @license https://github.com/sunrise-php/hydrator/blob/master/LICENSE |
|
9
|
|
|
* @link https://github.com/sunrise-php/hydrator |
|
10
|
|
|
*/ |
|
11
|
|
|
|
|
12
|
|
|
declare(strict_types=1); |
|
13
|
|
|
|
|
14
|
|
|
namespace Sunrise\Hydrator; |
|
15
|
|
|
|
|
16
|
|
|
use Doctrine\Common\Annotations\AnnotationReader; |
|
|
|
|
|
|
17
|
|
|
use Doctrine\Common\Annotations\Reader; |
|
18
|
|
|
use Generator; |
|
19
|
|
|
use LogicException; |
|
20
|
|
|
use ReflectionProperty; |
|
21
|
|
|
|
|
22
|
|
|
use function class_exists; |
|
23
|
|
|
use function sprintf; |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* @link https://github.com/doctrine/annotations |
|
27
|
|
|
* |
|
28
|
|
|
* @since 3.1.0 |
|
29
|
|
|
*/ |
|
30
|
|
|
final class DoctrineAnnotationReader implements AnnotationReaderInterface |
|
31
|
|
|
{ |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @var Reader |
|
35
|
|
|
*/ |
|
36
|
|
|
private Reader $reader; |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* Constructor of the class |
|
40
|
|
|
* |
|
41
|
|
|
* @param Reader $reader |
|
42
|
|
|
*/ |
|
43
|
1 |
|
public function __construct(Reader $reader) |
|
44
|
|
|
{ |
|
45
|
1 |
|
$this->reader = $reader; |
|
46
|
|
|
} |
|
47
|
|
|
|
|
48
|
|
|
/** |
|
49
|
|
|
* Creates the class instance with the doctrine's default annotation reader |
|
50
|
|
|
* |
|
51
|
|
|
* @return self |
|
52
|
|
|
* |
|
53
|
|
|
* @throws LogicException If the doctrine/annotations package isn't installed on the server. |
|
54
|
|
|
*/ |
|
55
|
1 |
|
public static function default(): self |
|
56
|
|
|
{ |
|
57
|
|
|
// @codeCoverageIgnoreStart |
|
58
|
|
|
if (!class_exists(AnnotationReader::class)) { |
|
59
|
|
|
throw new LogicException(sprintf( |
|
60
|
|
|
'The annotation reader {%s} requires the package doctrine/annotations, ' . |
|
61
|
|
|
'run the command `composer require doctrine/annotations` to resolve it.', |
|
62
|
|
|
__CLASS__, |
|
63
|
|
|
)); |
|
64
|
|
|
} // @codeCoverageIgnoreEnd |
|
65
|
|
|
|
|
66
|
1 |
|
return new self(new AnnotationReader()); |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
/** |
|
70
|
|
|
* @inheritDoc |
|
71
|
|
|
*/ |
|
72
|
1 |
|
public function getAnnotations(ReflectionProperty $target, string $name): Generator |
|
73
|
|
|
{ |
|
74
|
1 |
|
$annotations = $this->reader->getPropertyAnnotations($target); |
|
75
|
1 |
|
foreach ($annotations as $annotation) { |
|
76
|
1 |
|
if ($annotation instanceof $name) { |
|
77
|
1 |
|
yield $annotation; |
|
78
|
|
|
} |
|
79
|
|
|
} |
|
80
|
|
|
} |
|
81
|
|
|
} |
|
82
|
|
|
|
sunrise-php /
hydrator
Let?s assume that you have a directory layout like this:
. |-- OtherDir | |-- Bar.php | `-- Foo.php `-- SomeDir `-- Foo.phpand let?s assume the following content of
Bar.php:If both files
OtherDir/Foo.phpandSomeDir/Foo.phpare loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.phpHowever, as
OtherDir/Foo.phpdoes not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: