10000 minor #31984 [EventDispatcher] Add type-hints to EventDispatcherInter… · symfony/symfony@150f0f2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 150f0f2

Browse files
fabpotfabpot
committed
minor #31984 [EventDispatcher] Add type-hints to EventDispatcherInterface (derrabus)
This PR was merged into the 5.0-dev branch. Discussion ---------- [EventDispatcher] Add type-hints to EventDispatcherInterface | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #32179 | License | MIT | Doc PR | N/A This PR adds type-hints to `EventDispatcherInterface` to give it a more php7-like feeling. Adding these type-hints on master should not be a breaking change because we require php 7.2 there, which allows downstream classes/interfaces to remove a type-hint from a method signature. Commits ------- 2bc9472 [EventDispatcher] Add type-hints to EventDispatcherInterface.
2 parents 71525d4 + 2bc9472 commit 150f0f2

File tree

5 files changed

+29
-36
lines changed

5 files changed

+29
-36
lines changed

‎src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $sto
5353
/**
5454
* {@inheritdoc}
5555
*/
56-
public function addListener($eventName, $listener, $priority = 0)
56+
public function addListener(string $eventName, $listener, int $priority = 0)
5757
{
5858
$this->dispatcher->addListener($eventName, $listener, $priority);
5959
}
@@ -69,7 +69,7 @@ public function addSubscriber(EventSubscriberInterface $subscriber)
6969
/**
7070
* {@inheritdoc}
7171
*/
72-
public function removeListener($eventName, $listener)
72+
public function removeListener(string $eventName, $listener)
7373
{
7474
if (isset($this->wrappedListeners[$eventName])) {
7575
foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
@@ -95,15 +95,15 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
9595
/**
9696
* {@inheritdoc}
9797
*/
98-
public function getListeners($eventName = null)
98+
public function getListeners(string $eventName = null)
9999
{
100100
return $this->dispatcher->getListeners($eventName);
101101
}
102102

103103
/**
104104
* {@inheritdoc}
105105
*/
106-
public function getListenerPriority($eventName, $listener)
106+
public function getListenerPriority(string $eventName, $listener)
107107
{
108108
// we might have wrapped listeners for the event (if called while dispatching)
109109
// in that case get the priority by wrapper
@@ -121,7 +121,7 @@ public function getListenerPriority($eventName, $listener)
121121
/**
122122
* {@inheritdoc}
123123
*/
124-
public function hasListeners($eventName = null)
124+
public function hasListeners(string $eventName = null)
125125
{
126126
return $this->dispatcher->hasListeners($eventName);
127127
}
@@ -272,7 +272,7 @@ public function reset()
272272
*
273273
* @return mixed
274274
*/
275-
public function __call($method, $arguments)
275+
public function __call(string $method, array $arguments)
276276
{
277277
return $this->dispatcher->{$method}(...$arguments);
278278
}
@@ -291,7 +291,7 @@ protected function afterDispatch(string $eventName, object $event)
291291
{
292292
}
293293

294-
private function preProcess($eventName)
294+
private function preProcess(string $eventName): void
295295
{
296296
if (!$this->dispatcher->hasListeners($eventName)) {
297297
$this->orphanedEvents[$this->currentRequestHash][] = $eventName;
@@ -309,7 +309,7 @@ private function preProcess($eventName)
309309
}
310310
}
311311

312-
private function postProcess($eventName)
312+
private function postProcess(string $eventName): void
313313
{
314314
unset($this->wrappedListeners[$eventName]);
315315
$skipped = false;

‎src/Symfony/Component/EventDispatcher/DependencyInjection/RegisterListenersPass.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ class ExtractingEventDispatcher extends EventDispatcher implements EventSubscrib
134134
public static $aliases = [];
135135
public static $subscriber;
136136

137-
public function addListener($eventName, $listener, $priority = 0)
137+
public function addListener(string $eventName, $listener, int $priority = 0)
138138
{
139139
$this->listeners[] = [$eventName, $listener[1], $priority];
140140
}

‎src/Symfony/Component/EventDispatcher/EventDispatcher.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public function dispatch($event, string $eventName = null): object
7070
/**
7171
* {@inheritdoc}
7272
*/
73-
public function getListeners($eventName = null)
73+
public function getListeners(string $eventName = null)
7474
{
7575
if (null !== $eventName) {
7676
if (empty($this->listeners[$eventName])) {
@@ -96,7 +96,7 @@ public function getListeners($eventName = null)
9696
/**
9797
* {@inheritdoc}
9898
*/
99-
public function getListenerPriority($eventName, $listener)
99+
public function getListenerPriority(string $eventName, $listener)
100100
{
101101
if (empty($this->listeners[$eventName])) {
102102
return;
@@ -121,7 +121,7 @@ public function getListenerPriority($eventName, $listener)
121121
/**
122122
* {@inheritdoc}
123123
*/
124-
public function hasListeners($eventName = null)
124+
public function hasListeners(string $eventName = null)
125125
{
126126
if (null !== $eventName) {
127127
return !empty($this->listeners[$eventName]);
@@ -139,7 +139,7 @@ public function hasListeners($eventName = null)
139139
/**
140140
* {@inheritdoc}
141141
*/
142-
public function addListener($eventName, $listener, $priority = 0)
142+
public function addListener(string $eventName, $listener, int $priority = 0)
143143
{
144144
$this->listeners[$eventName][$priority][] = $listener;
145145
unset($this->sorted[$eventName], $this->optimized[$eventName]);
@@ -148,7 +148,7 @@ public function addListener($eventName, $listener, $priority = 0)
148148
/**
149149
* {@inheritdoc}
150150
*/
151-
public function removeListener($eventName, $listener)
151+
public function removeListener(string $eventName, $listener)
152152
{
153153
if (empty($this->listeners[$eventName])) {
154154
return;

‎src/Symfony/Component/EventDispatcher/EventDispatcherInterface.php

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,11 @@ public function dispatch($event, string $eventName = null): object;
3030
/**
3131
* Adds an event listener that listens on the specified events.
3232
*
33-
* @param string $eventName The event to listen on
34-
* @param callable $listener The listener
35-
* @param int $priority The higher this value, the earlier an event
36-
* listener will be triggered in the chain (defaults to 0)
33+
* @param callable $listener The listener
34+
* @param int $priority The higher this value, the earlier an event
35+
* listener will be triggered in the chain (defaults to 0)
3736
*/
38-
public function addListener($eventName, $listener, $priority = 0);
37+
public function addListener(string $eventName, $listener, int $priority = 0);
3938

4039
/**
4140
* Adds an event subscriber.
@@ -48,40 +47,34 @@ public function addSubscriber(EventSubscriberInterface $subscriber);
4847
/**
4948
* Removes an event listener from the specified events.
5049
*
51-
* @param string $eventName The event to remove a listener from
52-
* @param callable $listener The listener to remove
50+
* @param callable $listener The listener to remove
5351
*/
54-
public function removeListener($eventName, $listener);
52+
public function removeListener(string $eventName, $listener);
5553

5654
public function removeSubscriber(EventSubscriberInterface $subscriber);
5755

5856
/**
5957
* Gets the listeners of a specific event or all listeners sorted by descending priority.
6058
*
61-
* @param string|null $eventName The name of the event
62-
*
6359
* @return array The event listeners for the specified event, or all event listeners by event name
6460
*/
65-
public function getListeners($eventName = null);
61+
public function getListeners(string $eventName = null);
6662

6763
/**
6864
* Gets the listener priority for a specific event.
6965
*
7066
* Returns null if the event or the listener does not exist.
7167
*
72-
* @param string $eventName The name of the event
73-
* @param callable $listener The listener
68+
* @param callable $listener The listener
7469
*
7570
* @return int|null The event listener priority
7671
*/
77-
public function getListenerPriority($eventName, $listener);
72+
public function getListenerPriority(string $eventName, $listener);
7873

7974
/**
8075
* Checks whether an event has any registered listeners.
8176
*
82-
* @param string|null $eventName The name of the event
83-
*
8477
* @return bool true if the specified event has any listeners, false otherwise
8578
*/
86-
public function hasListeners($eventName = null);
79+
public function hasListeners(string $eventName = null);
8780
}

‎src/Symfony/Component/EventDispatcher/ImmutableEventDispatcher.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public function dispatch($event, string $eventName = null): object
3636
/**
3737
* {@inheritdoc}
3838
*/
39-
public function addListener($eventName, $listener, $priority = 0)
39+
public function addListener(string $eventName, $listener, int $priority = 0)
4040
{
4141
throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
4242
}
@@ -52,7 +52,7 @@ public function addSubscriber(EventSubscriberInterface $subscriber)
5252
/**
5353
* {@inheritdoc}
5454
*/
55-
public function removeListener($eventName, $listener)
55+
public function removeListener(string $eventName, $listener)
5656
{
5757
throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
5858
}
@@ -68,23 +68,23 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
6868
/**
6969
* {@inheritdoc}
7070
*/
71-
public function getListeners($eventName = null)
71+
public function getListeners(string $eventName = null)
7272
{
7373
return $this->dispatcher->getListeners($eventName);
7474
}
7575

7676
/**
7777
* {@inheritdoc}
7878
*/
79-
public function getListenerPriority($eventName, $listener)
79+
public function getListenerPriority(string $eventName, $listener)
8080
{
8181
return $this->dispatcher->getListenerPriority($eventName, $listener);
8282
}
8383

8484
/**
8585
* {@inheritdoc}
8686
*/
87-
public function hasListeners($eventName = null)
87+
public function hasListeners(string $eventName = null)
8888
{
8989
return $this->dispatcher->hasListeners($eventName);
9090
}

0 commit comments

Comments
 (0)
0