Skip to content

Commit 87fdf45

Browse files
committed
[EventDispatcher] tweaked public @api
1 parent e26d812 commit 87fdf45

4 files changed

+12
-8
lines changed

Event.php

+6
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@
3737
* @author Jonathan Wage <jonwage@gmail.com>
3838
* @author Roman Borschel <roman@code-factory.org>
3939
* @author Bernhard Schussek <bschussek@gmail.com>
40+
*
41+
* @api
4042
*/
4143
class Event
4244
{
@@ -50,6 +52,8 @@ class Event
5052
*
5153
* @see Event::stopPropagation
5254
* @return Boolean Whether propagation was already stopped for this event.
55+
*
56+
* @api
5357
*/
5458
public function isPropagationStopped()
5559
{
@@ -62,6 +66,8 @@ public function isPropagationStopped()
6266
* If multiple event listeners are connected to the same event, no
6367
* further event listener will be triggered once any trigger calls
6468
* stopPropagation().
69+
*
70+
* @api
6571
*/
6672
public function stopPropagation()
6773
{

EventDispatcher.php

+2-4
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,6 @@ public function dispatch($eventName, Event $event = null)
6161

6262
/**
6363
* @see EventDispatcherInterface::getListeners
64-
*
65-
* @api
6664
*/
6765
public function getListeners($eventName = null)
6866
{
@@ -89,8 +87,6 @@ public function getListeners($eventName = null)
8987

9088
/**
9189
* @see EventDispatcherInterface::hasListeners
92-
*
93-
* @api
9490
*/
9591
public function hasListeners($eventName = null)
9692
{
@@ -126,6 +122,8 @@ public function removeListener($eventName, $listener)
126122

127123
/**
128124
* @see EventDispatcherInterface::addSubscriber
125+
*
126+
* @api
129127
*/
130128
public function addSubscriber(EventSubscriberInterface $subscriber)
131129
{

EventDispatcherInterface.php

-4
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,6 @@ function removeSubscriber(EventSubscriberInterface $subscriber);
7979
*
8080
* @return array The event listeners for the specified event, or all event
8181
* listeners by event name.
82-
*
83-
* @api
8482
*/
8583
function getListeners($eventName = null);
8684

@@ -91,8 +89,6 @@ function getListeners($eventName = null);
9189
*
9290
* @return Boolean TRUE if the specified event has any listeners, FALSE
9391
* otherwise.
94-
*
95-
* @api
9692
*/
9793
function hasListeners($eventName = null);
9894
}

EventSubscriberInterface.php

+4
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
* @author Jonathan Wage <jonwage@gmail.com>
3434
* @author Roman Borschel <roman@code-factory.org>
3535
* @author Bernhard Schussek <bschussek@gmail.com>
36+
*
37+
* @api
3638
*/
3739
interface EventSubscriberInterface
3840
{
@@ -50,6 +52,8 @@ interface EventSubscriberInterface
5052
* * array('eventName' => array('methodName', $priority))
5153
*
5254
* @return array The event names to listen to
55+
*
56+
* @api
5357
*/
5458
static function getSubscribedEvents();
5559
}

0 commit comments

Comments
 (0)