[Summary view] [Print] [Text view]

   1  # Changelog
   2  
   3  All notable changes to this project will be documented in this file, in reverse chronological order by release.
   4  
   5  ## 3.2.1 - 2018-04-25
   6  
   7  ### Added
   8  
   9  - [#66](https://github.com/zendframework/zend-eventmanager/pull/66) adds support for PHP 7.2.
  10  
  11  ### Changed
  12  
  13  - Nothing.
  14  
  15  ### Deprecated
  16  
  17  - Nothing.
  18  
  19  ### Removed
  20  
  21  - Nothing.
  22  
  23  ### Fixed
  24  
  25  - Nothing.
  26  
  27  ## 3.2.0 - 2017-07-11
  28  
  29  ### Added
  30  
  31  - Nothing.
  32  
  33  ### Deprecated
  34  
  35  - Nothing.
  36  
  37  ### Removed
  38  
  39  - [#47](https://github.com/zendframework/zend-eventmanager/pull/47) removes
  40    support for PHP 5.5 and HHVM.
  41  
  42  ### Fixed
  43  
  44  - Nothing.
  45  
  46  ## 3.1.0 - 2016-12-19
  47  
  48  ### Added
  49  
  50  - [#26](https://github.com/zendframework/zend-eventmanager/pull/26) publishes
  51    the documentation to https://zendframework.github.io/zend-eventmanager/
  52  
  53  ### Changes
  54  
  55  - [#17](https://github.com/zendframework/zend-eventmanager/pull/17) makes a
  56    number of internal changes to how listeners are stored in order to improve
  57    performance, by as much as 10% in the scenario used in the MVC layer.
  58    
  59    Additionally, it optimizes when the target and event arguments are injected
  60    into an event, eliminating that step entirely when either is unavailable.
  61  
  62  ### Deprecated
  63  
  64  - Nothing.
  65  
  66  ### Removed
  67  
  68  - Nothing.
  69  
  70  ### Fixed
  71  
  72  - Nothing.
  73  
  74  ## 3.0.1 - 2016-02-18
  75  
  76  ### Added
  77  
  78  - Nothing.
  79  
  80  ### Deprecated
  81  
  82  - Nothing.
  83  
  84  ### Removed
  85  
  86  - Nothing.
  87  
  88  ### Fixed
  89  
  90  - [#24](https://github.com/zendframework/zend-eventmanager/pull/24) updates the
  91    zend-stdlib dependency to `^2.7.3 || ^3.0`, allowing either major version.
  92  
  93  ## 3.0.0 - 2016-01-12
  94  
  95  ### Added
  96  
  97  - [Migration documentation](doc/book/migration/) was added.
  98  - [Automated benchmarks](benchmarks/) were added.
  99  - `EventManager::__construct()` now accepts an optional
 100    `SharedEventManagerInterface` instance as the first argument, and an optional
 101    array of identifiers as the second. As identifiers have no meaning without a
 102    shared manager present, they are secondary to providing the shared manager.
 103  - `EventManagerInterface::trigger()` changes its signature to
 104    `trigger($eventName, $target = null, $argv = [])`; each argument has exactly
 105    one possible meaning; the `$eventName` can only be a string event name. The
 106    fourth `$callback` argument is removed.
 107  - `EventManagerInterface::triggerUntil()` changes its signature to
 108    `triggerUntil(callable $callback, $eventName, $target = null, $argv = null)`.
 109    Each argument has exactly one meaning.
 110  - `EventManagerInterface` adds two new methods for triggering provided
 111    `EventInterface` arguments: `triggerEvent(EventInterface $event)` and
 112    `triggerEventUntil(callable $callback, EventInterface $event)`.
 113  - `EventManagerInterface::attach()` and `detach()` change their signatures to
 114    `attach($eventName, callable $listener, $priority = 1)` and `detach(callable
 115    $listener, $eventName = null)`, respectively. Note that `$eventName` can now
 116    only be a string event name, not an array or `Traversable`.
 117  - `EventManagerInterface::setIdentifiers()` and `addIdentifiers()` change their
 118    signatures to each only accept an *array* of identifiers.
 119  - `SharedEventManagerInterface::getListeners()` changes signature to
 120    `getListeners(array $identifiers, $eventName)` and now guarantees return of an
 121    array. Note that the second argument is now *required*.
 122  - `SharedEventManagerInterface::attach()` changes signature to
 123    `attach($identifier, $eventName, callable $listener, $priority = 1)`. The
 124    `$identifier` and `$eventName` **must** be strings.
 125  - `SharedEventManagerInterface::detach()` changes signature to `detach(callable
 126    $listener, $identifier = null, $eventName = null)`; `$identifier` and
 127    `$eventName` **must** be strings if passed.
 128  - `ListenerAggregateInterface::attach()` adds an optional `$priority = 1`
 129    argument. This was used already in v2, but not dictated by the interface.
 130  - `FilterInterface::attach()` and `detach()` have changed signature to
 131    `attach(callable $callback)` and `detach(callable $ilter)`, respectively.
 132  - `LazyListener` allows wrapping:
 133    - fetching a listener service from a container-interop container, and
 134    - invoking a designated listener method with the provided event.
 135  - `LazyEventListener` extends `LazyListener`, and provides metadata for
 136    discovering the intended event name and priority at which to attach the lazy
 137    listener; these are consumed by:
 138  - `LazyListenerAggregate`, which, provided a list of `LazyEventListeners` and/or
 139    definitions to use to create them, acts as an aggregate for attaching a number
 140    of such listeners at once.
 141  - [#20](https://github.com/zendframework/zend-eventmanager/pull/20) updates the
 142    trait `Zend\EventManager\Test\EventListenerIntrospectionTrait` so that the
 143    implementation will work with the v3 changes; the tests written for v2
 144    continue to pass, allowing this trait to be used to provide compatibility
 145    testing between v2 and v3.
 146  
 147  ### Deprecated
 148  
 149  - Nothing.
 150  
 151  ### Removed
 152  
 153  - `GlobalEventManager` and `StaticEventManager` are removed (with prejudice!).
 154  - `ProvidesEvents`, which was previously deprecated, is removed.
 155  - `EventManagerInterface::setSharedManager()` is removed. Shared managers are
 156    now expected to be injected during instantiation.
 157  - `EventManagerInterface::getEvents()` and `getListeners()` are removed; they
 158    had now purpose within the implementation.
 159  - `EventManagerInterface::setEventClass()` was renamed to `setEventPrototype()`,
 160    which now expects an `EventInterface` instance. That instance will be cloned
 161    whenever a new event is created.
 162  - `EventManagerInterface::attachAggregate()` and `detachAggregate()` are
 163    removed. Users should use the `attach()` and `detach()` methods of the
 164    aggregates themselves.
 165  - `SharedEventAggregateAwareInterface` and `SharedListenerAggregateInterface`
 166    are removed. This was an undocumented and largely unused feature.
 167  - `SharedEventManagerAwareInterface` is removed. A new interface,
 168    `SharedEventsCapableInterface` defines the `getSharedManager()` method from
 169    the interface, and `EventManagerInterface` extends that new interface.
 170  - `SharedEventManagerInterface::getEvents()` is removed, as it had no purpose in
 171    the implementation.
 172  - `ResponseCollection::setStopped()` no longer implements a fluent interface.
 173  
 174  ### Fixed
 175  
 176  - `FilterIterator::insert()` has been modified to raise an exception if the value provided is not a callable.
 177  
 178  ## 2.6.2 - 2016-01-12
 179  
 180  ### Added
 181  
 182  - [#19](https://github.com/zendframework/zend-eventmanager/pull/19) adds a new
 183    trait, `Zend\EventManager\Test\EventListenerIntrospectionTrait`, intended for
 184    composition in unit tests. It provides a number of methods that can be used
 185    to retrieve listeners with or without associated priority, and the assertion
 186    `assertListenerAtPriority(callable $listener, $priority, $event, EventManager $events, $message = '')`,
 187    which can be used for testing that a listener was registered at the specified
 188    priority with the specified event.
 189  
 190    The features in this patch are intended to facilitate testing against both
 191    version 2 and version 3 of zend-eventmanager, as it provides a consistent API
 192    for retrieving lists of events and listeners between the two versions.
 193  
 194  ### Deprecated
 195  
 196  - Nothing.
 197  
 198  ### Removed
 199  
 200  - Nothing.
 201  
 202  ### Fixed
 203  
 204  - Nothing.
 205  
 206  ## 2.6.0 - 2015-09-29
 207  
 208  ### Added
 209  
 210  - Added `Zend\EventManager\SharedEventsCapableInterface`. This interface will
 211    largely replace `Zend\EventManager\SharedEventManagerAwareInterface` in
 212    version 3, and the latter was updated to extend it.
 213  - Added `EventManager::triggerEvent(EventInterface $event)` as a
 214    forwards-compatibility feature.
 215  - Add `EventManager::triggerEventUntil(callable $callback, EventIterface $event)`
 216    as a forwards-compatibility feature.
 217  - Adds [Athletic](https://github.com/polyfractal/athletic) benchmarks to aid in
 218    gauging performanc impact of changes; these are a development change only.
 219  
 220  ### Deprecated
 221  
 222  - Marked `GlobalEventManager` as deprecated; this class will be removed in
 223    version 3.
 224  - Marked `StaticEventManager` as deprecated; this class will be removed in
 225    version 3.
 226  - Marked `SharedListenerAggregateInterface` as deprecated; this interface will
 227    be removed in version 3.
 228  - Marked `SharedEventAggregateAwareInterface` as deprecated; this interface will
 229    be removed in version 3.
 230  - Marked `SharedEventManagerAwareInterface` as deprecated; this interface will
 231    be removed in version 3.
 232  - Marked `EventManager::setSharedManager()` as deprecated; this method will be
 233    removed in version 3.
 234  - Marked `EventManager::unsetSharedManager()` as deprecated; this method will be
 235    removed in version 3.
 236  - Marked `EventManagerInterface::` and `EventManager::getEvents()` as
 237    deprecated; this method will be removed in version 3.
 238  - Marked `EventManagerInterface::` and `EventManager::getListeners()` as
 239    deprecated; this method will be removed in version 3.
 240  - Marked `EventManagerInterface::` and `Eventmanager::setEventClass()` as
 241    deprecated; this method is renamed to `setEventPrototype(EventInterface $event)`
 242    in version 3.
 243  - Marked `EventManagerInterface::` and `EventManager::attachAggregate()` as
 244    deprecated; this method will be removed in version 3.
 245  - Marked `EventManagerInterface::` and `EventManager::detachAggregate()` as
 246    deprecated; this method will be removed in version 3.
 247  - Marked `SharedEventManagerInterface::` and `SharedEventManager::getEvents()`
 248    as deprecated; this method will be removed in version 3.
 249  
 250  ### Removed
 251  
 252  - Nothing.
 253  
 254  ### Fixed
 255  
 256  - Nothing.
 257  
 258  ## 2.5.2 - 2015-07-16
 259  
 260  ### Added
 261  
 262  - [#5](https://github.com/zendframework/zend-eventmanager/pull/5) adds a number
 263    of unit tests to improve test coverage, and thus maintainability and
 264    stability.
 265  
 266  ### Deprecated
 267  
 268  - Nothing.
 269  
 270  ### Removed
 271  
 272  - [#3](https://github.com/zendframework/zend-eventmanager/pull/3) removes some
 273    PHP 5.3- and 5.4-isms (such as marking Traits as requiring 5.4, and closing
 274    over a copy of `$this`) from the test suite.
 275  
 276  ### Fixed
 277  
 278  - [#5](https://github.com/zendframework/zend-eventmanager/pull/5) fixes a bug in
 279    `FilterIterator` that occurs when attempting to extract from an empty heap.