forked from sebastianbergmann/phpunit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTypeMap.php
More file actions
190 lines (175 loc) · 5.47 KB
/
Copy pathTypeMap.php
File metadata and controls
190 lines (175 loc) · 5.47 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<?php declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Event;
use function array_key_exists;
use function class_exists;
use function class_implements;
use function in_array;
use function interface_exists;
use function sprintf;
/**
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class TypeMap
{
/**
* @psalm-var array<class-string, class-string>
*/
private array $mapping = [];
/**
* @psalm-param class-string $subscriberInterface
* @psalm-param class-string $eventClass
*
* @throws EventAlreadyAssignedException
* @throws InvalidEventException
* @throws InvalidSubscriberException
* @throws SubscriberTypeAlreadyRegisteredException
* @throws UnknownEventException
* @throws UnknownSubscriberException
*/
public function addMapping(string $subscriberInterface, string $eventClass): void
{
$this->ensureSubscriberInterfaceExists($subscriberInterface);
$this->ensureSubscriberInterfaceExtendsInterface($subscriberInterface);
$this->ensureEventClassExists($eventClass);
$this->ensureEventClassImplementsEventInterface($eventClass);
$this->ensureSubscriberWasNotAlreadyRegistered($subscriberInterface);
$this->ensureEventWasNotAlreadyAssigned($eventClass);
$this->mapping[$subscriberInterface] = $eventClass;
}
public function isKnownSubscriberType(Subscriber $subscriber): bool
{
foreach (class_implements($subscriber) as $interface) {
if (array_key_exists($interface, $this->mapping)) {
return true;
}
}
return false;
}
public function isKnownEventType(Event $event): bool
{
return in_array($event::class, $this->mapping, true);
}
/**
* @psalm-return class-string
*
* @throws MapError
*/
public function map(Subscriber $subscriber): string
{
foreach (class_implements($subscriber) as $interface) {
if (array_key_exists($interface, $this->mapping)) {
return $this->mapping[$interface];
}
}
throw new MapError(
sprintf(
'Subscriber "%s" does not implement a known interface',
$subscriber::class,
),
);
}
/**
* @psalm-param class-string $subscriberInterface
*
* @throws UnknownSubscriberException
*/
private function ensureSubscriberInterfaceExists(string $subscriberInterface): void
{
if (!interface_exists($subscriberInterface)) {
throw new UnknownSubscriberException(
sprintf(
'Subscriber "%s" does not exist or is not an interface',
$subscriberInterface,
),
);
}
}
/**
* @psalm-param class-string $eventClass
*
* @throws UnknownEventException
*/
private function ensureEventClassExists(string $eventClass): void
{
if (!class_exists($eventClass)) {
throw new UnknownEventException(
sprintf(
'Event class "%s" does not exist',
$eventClass,
),
);
}
}
/**
* @psalm-param class-string $subscriberInterface
*
* @throws InvalidSubscriberException
*/
private function ensureSubscriberInterfaceExtendsInterface(string $subscriberInterface): void
{
if (!in_array(Subscriber::class, class_implements($subscriberInterface), true)) {
throw new InvalidSubscriberException(
sprintf(
'Subscriber "%s" does not extend Subscriber interface',
$subscriberInterface,
),
);
}
}
/**
* @psalm-param class-string $eventClass
*
* @throws InvalidEventException
*/
private function ensureEventClassImplementsEventInterface(string $eventClass): void
{
if (!in_array(Event::class, class_implements($eventClass), true)) {
throw new InvalidEventException(
sprintf(
'Event "%s" does not implement Event interface',
$eventClass,
),
);
}
}
/**
* @psalm-param class-string $subscriberInterface
*
* @throws SubscriberTypeAlreadyRegisteredException
*/
private function ensureSubscriberWasNotAlreadyRegistered(string $subscriberInterface): void
{
if (array_key_exists($subscriberInterface, $this->mapping)) {
throw new SubscriberTypeAlreadyRegisteredException(
sprintf(
'Subscriber type "%s" already registered',
$subscriberInterface,
),
);
}
}
/**
* @psalm-param class-string $eventClass
*
* @throws EventAlreadyAssignedException
*/
private function ensureEventWasNotAlreadyAssigned(string $eventClass): void
{
if (in_array($eventClass, $this->mapping, true)) {
throw new EventAlreadyAssignedException(
sprintf(
'Event "%s" already assigned',
$eventClass,
),
);
}
}
}