Deprecations/additions for 2.6.0

- [X] Mark GlobalEventManager as deprecated
- [X] Mark StaticEventManager as deprecated
- [X] Mark EventManager::setSharedManager as deprecated
  - [X] Add SharedEventsCapableInterface
  - [X] Updated SharedEventManagerAwareInterface to extend SharedEventsCapableInterface
- [X] Mark EventManager::unsetSharedManager as deprecated
- [X] Mark EventManager(Interface)?::getEvents as deprecated
- [X] Mark EventManager(Interface)?::getListeners as deprecated
- [X] Mark EventManager(Interface)?::setEventClass as deprecated
- [X] Mark EventManager(Interface)?::attachAggregate as deprecated
- [X] Mark EventManager(Interface)?::detachAggregate as deprecated
- [X] Mark SharedListenerAggregateInterface as deprecated
- [X] Mark SharedEventAggregateAwareInterface as deprecated
- [X] Mark SharedEventManagerAwareInterface as deprecated
- [X] Mark SharedEventManager(Interface)?::getEvents as deprecated
- [X] Add EventManager::triggerEvent() (but not at interface level)
- [X] Add EventManager::triggerEventUntil() (but not at interface level)

Author: weierophinney

src/EventManager.php

@@ -62,6 +62,9 @@ public function __construct($identifiers = null)
     /**
      * Set the event class to utilize
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  string $class
      * @return EventManager
      */
@@ -74,6 +77,9 @@ public function setEventClass($class)
     /**
      * Set shared event manager
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param SharedEventManagerInterface $sharedEventManager
      * @return EventManager
      */
@@ -87,6 +93,9 @@ public function setSharedManager(SharedEventManagerInterface $sharedEventManager
     /**
      * Remove any shared event manager currently attached
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @return void
      */
     public function unsetSharedManager()
@@ -229,6 +238,29 @@ public function triggerUntil($event, $target, $argv = null, $callback = null)
         return $this->trigger($event, $target, $argv, $callback);
     }
 
+    /**
+     * Trigger an event instance.
+     *
+     * @param EventInterface $event
+     * @return ResponseCollection
+     */
+    public function triggerEvent(EventInterface $event)
+    {
+        return $this->triggerListeners($event->getName(), $event);
+    }
+
+    /**
+     * Trigger an event instance, short-circuiting if a listener response evaluates true via the callback.
+     *
+     * @param callable $callback
+     * @param EventInterface $event
+     * @return ResponseCollection
+     */
+    public function triggerEventUntil(callable $callback, EventInterface $event)
+    {
+        return $this->triggerListeners($event->getName(), $event, $callback);
+    }
+
     /**
      * Attach a listener to an event
      *
@@ -293,6 +325,9 @@ public function attach($event, $callback = null, $priority = 1)
      * one or more times, typically to attach to multiple events using local
      * methods.
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  ListenerAggregateInterface $aggregate
      * @param  int $priority If provided, a suggested priority for the aggregate to use
      * @return mixed return value of {@link ListenerAggregateInterface::attach()}
@@ -343,6 +378,9 @@ public function detach($listener)
      * Listener aggregates accept an EventManagerInterface instance, and call detach()
      * of all previously attached listeners.
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  ListenerAggregateInterface $aggregate
      * @return mixed return value of {@link ListenerAggregateInterface::detach()}
      */
@@ -354,6 +392,9 @@ public function detachAggregate(ListenerAggregateInterface $aggregate)
     /**
      * Retrieve all registered events
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @return array
      */
     public function getEvents()
@@ -364,6 +405,9 @@ public function getEvents()
     /**
      * Retrieve all listeners for a given event
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  string $event
      * @return PriorityQueue
      */

src/EventManagerInterface.php

@@ -74,13 +74,19 @@ public function detach($listener);
     /**
      * Get a list of events for which this collection has listeners
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @return array
      */
     public function getEvents();
 
     /**
      * Retrieve a list of listeners registered to a given event
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  string $event
      * @return array|object
      */
@@ -97,6 +103,9 @@ public function clearListeners($event);
     /**
      * Set the event class to utilize
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  string $class
      * @return EventManagerInterface
      */
@@ -128,6 +137,9 @@ public function addIdentifiers($identifiers);
     /**
      * Attach a listener aggregate
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  ListenerAggregateInterface $aggregate
      * @param  int $priority If provided, a suggested priority for the aggregate to use
      * @return mixed return value of {@link ListenerAggregateInterface::attach()}
@@ -137,6 +149,9 @@ public function attachAggregate(ListenerAggregateInterface $aggregate, $priority
     /**
      * Detach a listener aggregate
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  ListenerAggregateInterface $aggregate
      * @return mixed return value of {@link ListenerAggregateInterface::detach()}
      */

src/GlobalEventManager.php

@@ -17,6 +17,10 @@
  *
  * Use the EventManager when you want to create a per-instance notification
  * system for your objects.
+ *
+ * @deprecated This class is deprecated with 2.6.0, and will be removed in
+ *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+ *     for details.
  */
 class GlobalEventManager
 {

src/SharedEventAggregateAwareInterface.php

@@ -11,6 +11,10 @@
 
 /**
  * Interface for allowing attachment of shared aggregate listeners.
+ *
+ * @deprecated This interface is deprecated with 2.6.0, and will be removed in
+ *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+ *     for details.
  */
 interface SharedEventAggregateAwareInterface
 {

src/SharedEventManager.php

@@ -123,6 +123,9 @@ public function detachAggregate(SharedListenerAggregateInterface $aggregate)
     /**
      * Retrieve all registered events for a given resource
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  string|int $id
      * @return array
      */

src/SharedEventManagerAwareInterface.php

@@ -11,8 +11,12 @@
 
 /**
  * Interface to automate setter injection for a SharedEventManagerInterface instance
+ *
+ * @deprecated This interface is deprecated with 2.6.0, and will be removed in
+ *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+ *     for details.
  */
-interface SharedEventManagerAwareInterface
+interface SharedEventManagerAwareInterface extends SharedEventsCapableInterface
 {
     /**
      * Inject a SharedEventManager instance
@@ -22,13 +26,6 @@ interface SharedEventManagerAwareInterface
      */
     public function setSharedManager(SharedEventManagerInterface $sharedEventManager);
 
-    /**
-     * Get shared collections container
-     *
-     * @return SharedEventManagerInterface
-     */
-    public function getSharedManager();
-
     /**
      * Remove any shared collections
      *

src/SharedEventManagerInterface.php

@@ -49,6 +49,9 @@ public function detach($id, CallbackHandler $listener);
     /**
      * Retrieve all registered events for a given resource
      *
+     * @deprecated This method is deprecated with 2.6.0, and will be removed in
+     *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+     *     for details.
      * @param  string|int $id
      * @return array
      */

src/SharedEventsCapableInterface.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zend-eventmanager for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-eventmanager/blob/master/LICENSE.md
+ */
+
+namespace Zend\EventManager;
+
+/**
+ * Interface indicating that an object composes or can compose a
+ * SharedEventManagerInterface instance.
+ */
+interface SharedEventsCapableInterface
+{
+    /**
+     * Retrieve the shared event manager, if composed.
+     *
+     * @return null|SharedEventManagerInterface
+     */
+    public function getSharedManager();
+}

src/SharedListenerAggregateInterface.php

@@ -16,6 +16,10 @@
  * with a SharedEventManager, without an event name. The {@link attach()} method will
  * then be called with the current SharedEventManager instance, allowing the class to
  * wire up one or more listeners.
+ *
+ * @deprecated This interface is deprecated with 2.6.0, and will be removed in
+ *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+ *     for details.
  */
 interface SharedListenerAggregateInterface
 {

src/StaticEventManager.php

@@ -11,6 +11,10 @@
 
 /**
  * Static version of EventManager
+ *
+ * @deprecated This class is deprecated with 2.6.0, and will be removed in
+ *     3.0.0. See {@link https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md}
+ *     for details.
  */
 class StaticEventManager extends SharedEventManager
 {