Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.

Commit 4aa14b5

Browse files
committed
Incorporate feedback
- Per @akrabat, the "3.0.0" verbiage needed to be on the same line as the annotation.
1 parent 45495ad commit 4aa14b5

9 files changed

+44
-40
lines changed

src/EventManager.php

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ public function __construct($identifiers = null)
6262
/**
6363
* Set the event class to utilize
6464
*
65-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
66-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
65+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
66+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
6767
* for details.
6868
* @param string $class
6969
* @return EventManager
@@ -77,8 +77,8 @@ public function setEventClass($class)
7777
/**
7878
* Set shared event manager
7979
*
80-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
81-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
80+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
81+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
8282
* for details.
8383
* @param SharedEventManagerInterface $sharedEventManager
8484
* @return EventManager
@@ -93,8 +93,8 @@ public function setSharedManager(SharedEventManagerInterface $sharedEventManager
9393
/**
9494
* Remove any shared event manager currently attached
9595
*
96-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
97-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
96+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
97+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
9898
* for details.
9999
* @return void
100100
*/
@@ -221,12 +221,14 @@ public function trigger($event, $target = null, $argv = [], $callback = null)
221221
* Triggers listeners until the provided callback evaluates the return
222222
* value of one as true, or until all listeners have been executed.
223223
*
224+
* @deprecated The signature of this method will change in 3.0.0.
225+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/changed.md}
226+
* for details.
224227
* @param string|EventInterface $event
225228
* @param string|object $target Object calling emit, or symbol describing target (such as static method name)
226229
* @param array|ArrayAccess $argv Array of arguments; typically, should be associative
227230
* @param callable $callback
228231
* @return ResponseCollection
229-
* @deprecated Please use trigger()
230232
* @throws Exception\InvalidCallbackException if invalid callable provided
231233
*/
232234
public function triggerUntil($event, $target, $argv = null, $callback = null)
@@ -325,8 +327,8 @@ public function attach($event, $callback = null, $priority = 1)
325327
* one or more times, typically to attach to multiple events using local
326328
* methods.
327329
*
328-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
329-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
330+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
331+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
330332
* for details.
331333
* @param ListenerAggregateInterface $aggregate
332334
* @param int $priority If provided, a suggested priority for the aggregate to use
@@ -378,8 +380,8 @@ public function detach($listener)
378380
* Listener aggregates accept an EventManagerInterface instance, and call detach()
379381
* of all previously attached listeners.
380382
*
381-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
382-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
383+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
384+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
383385
* for details.
384386
* @param ListenerAggregateInterface $aggregate
385387
* @return mixed return value of {@link ListenerAggregateInterface::detach()}
@@ -392,8 +394,8 @@ public function detachAggregate(ListenerAggregateInterface $aggregate)
392394
/**
393395
* Retrieve all registered events
394396
*
395-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
396-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
397+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
398+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
397399
* for details.
398400
* @return array
399401
*/
@@ -405,8 +407,8 @@ public function getEvents()
405407
/**
406408
* Retrieve all listeners for a given event
407409
*
408-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
409-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
410+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
411+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
410412
* for details.
411413
* @param string $event
412414
* @return PriorityQueue

src/EventManagerInterface.php

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,14 @@ public function trigger($event, $target = null, $argv = [], $callback = null);
4444
* - Passing event name, target, Event object, and callback
4545
* - Passing event name, target, array|ArrayAccess of arguments, and callback
4646
*
47+
* @deprecated The signature of this method will change in 3.0.0.
48+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/changed.md}
49+
* for details.
4750
* @param string|EventInterface $event
4851
* @param object|string $target
4952
* @param array|object $argv
5053
* @param callable $callback
5154
* @return ResponseCollection
52-
* @deprecated Please use trigger()
5355
*/
5456
public function triggerUntil($event, $target, $argv = null, $callback = null);
5557

@@ -74,8 +76,8 @@ public function detach($listener);
7476
/**
7577
* Get a list of events for which this collection has listeners
7678
*
77-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
78-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
79+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
80+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
7981
* for details.
8082
* @return array
8183
*/
@@ -84,8 +86,8 @@ public function getEvents();
8486
/**
8587
* Retrieve a list of listeners registered to a given event
8688
*
87-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
88-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
89+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
90+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
8991
* for details.
9092
* @param string $event
9193
* @return array|object
@@ -103,8 +105,8 @@ public function clearListeners($event);
103105
/**
104106
* Set the event class to utilize
105107
*
106-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
107-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
108+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
109+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
108110
* for details.
109111
* @param string $class
110112
* @return EventManagerInterface
@@ -137,8 +139,8 @@ public function addIdentifiers($identifiers);
137139
/**
138140
* Attach a listener aggregate
139141
*
140-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
141-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
142+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
143+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
142144
* for details.
143145
* @param ListenerAggregateInterface $aggregate
144146
* @param int $priority If provided, a suggested priority for the aggregate to use
@@ -149,8 +151,8 @@ public function attachAggregate(ListenerAggregateInterface $aggregate, $priority
149151
/**
150152
* Detach a listener aggregate
151153
*
152-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
153-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
154+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
155+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
154156
* for details.
155157
* @param ListenerAggregateInterface $aggregate
156158
* @return mixed return value of {@link ListenerAggregateInterface::detach()}

src/GlobalEventManager.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
* Use the EventManager when you want to create a per-instance notification
1919
* system for your objects.
2020
*
21-
* @deprecated This class is deprecated with 2.6.0, and will be removed in
22-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
21+
* @deprecated This class is deprecated with 2.6.0, and will be removed in 3.0.0.
22+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
2323
* for details.
2424
*/
2525
class GlobalEventManager

src/SharedEventAggregateAwareInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
/**
1313
* Interface for allowing attachment of shared aggregate listeners.
1414
*
15-
* @deprecated This interface is deprecated with 2.6.0, and will be removed in
16-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
15+
* @deprecated This interface is deprecated with 2.6.0, and will be removed in 3.0.0.
16+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
1717
* for details.
1818
*/
1919
interface SharedEventAggregateAwareInterface

src/SharedEventManager.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ public function detachAggregate(SharedListenerAggregateInterface $aggregate)
123123
/**
124124
* Retrieve all registered events for a given resource
125125
*
126-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
127-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
126+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
127+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
128128
* for details.
129129
* @param string|int $id
130130
* @return array

src/SharedEventManagerAwareInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
/**
1313
* Interface to automate setter injection for a SharedEventManagerInterface instance
1414
*
15-
* @deprecated This interface is deprecated with 2.6.0, and will be removed in
16-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
15+
* @deprecated This interface is deprecated with 2.6.0, and will be removed in 3.0.0.
16+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
1717
* for details.
1818
*/
1919
interface SharedEventManagerAwareInterface extends SharedEventsCapableInterface

src/SharedEventManagerInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ public function detach($id, CallbackHandler $listener);
4949
/**
5050
* Retrieve all registered events for a given resource
5151
*
52-
* @deprecated This method is deprecated with 2.6.0, and will be removed in
53-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
52+
* @deprecated This method is deprecated with 2.6.0, and will be removed in 3.0.0.
53+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
5454
* for details.
5555
* @param string|int $id
5656
* @return array

src/SharedListenerAggregateInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
* then be called with the current SharedEventManager instance, allowing the class to
1818
* wire up one or more listeners.
1919
*
20-
* @deprecated This interface is deprecated with 2.6.0, and will be removed in
21-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
20+
* @deprecated This interface is deprecated with 2.6.0, and will be removed in 3.0.0.
21+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
2222
* for details.
2323
*/
2424
interface SharedListenerAggregateInterface

src/StaticEventManager.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
/**
1313
* Static version of EventManager
1414
*
15-
* @deprecated This class is deprecated with 2.6.0, and will be removed in
16-
* 3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
15+
* @deprecated This class is deprecated with 2.6.0, and will be removed in 3.0.0.
16+
* See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
1717
* for details.
1818
*/
1919
class StaticEventManager extends SharedEventManager

0 commit comments

Comments
 (0)