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

Deprecations to create in 2.6.0 #10

Merged
merged 2 commits into from
Sep 29, 2015

Conversation

weierophinney
Copy link
Member

Per #4, we need to mark a number of features as deprecated for an upcoming 2.6.0 release. This should be done against master.

Deprecations can be done via annotations; all deprecations MUST also be noted in the CHANGELOG.md.

  • Mark GlobalEventManager as deprecated
  • Mark StaticEventManager as deprecated
  • Mark EventManager(Interface)?::setSharedManager as deprecated
  • Mark EventManager(Interface)?::getEvents as deprecated
  • Mark EventManager(Interface)?::getListeners as deprecated
  • Mark EventManager(Interface)?::setEventClass as deprecated
  • Mark EventManager(Interface)?::attachAggregate as deprecated
  • Mark EventManager(Interface)?::detachAggregate as deprecated
  • Mark SharedListenerAggregateInterface as deprecated
  • Mark SharedEventAggregateAwareInterface as deprecated
  • Mark SharedEventManagerAwareInterface as deprecated
  • Mark SharedEventManagerInterface::getEvents as deprecated
  • Add EventManager::triggerEvent() (but not at interface level)
  • Add EventManager::triggerEventUntil() (but not at interface level)

@gianarb
Copy link

gianarb commented Sep 29, 2015

I can tag this methods but can you confirm me this way?

/**
 * @deprecated This method will be removed since version 3.0
 */
/**
 * @deprecated This class will be removed since version 3.0
 */

Thanks

@weierophinney
Copy link
Member Author

@gianarb Let's go with:

/**
 * @deprecated This {class or method} is deprecated with 2.6.0, and will be removed in 3.0.0. Please see {link to doc/book/migration/removed.md} for details.
 */

I need to figure out where the link will live; likely the develop branch, however.

@weierophinney
Copy link
Member Author

The link will be https://github.com/zendframework/zend-eventmanager/blob/develop/doc/book/migration/removed.md

@gianarb Ping me on IRC if you see this; I plan to start work on it unless I hear from you shortly. :)

- [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)
- Per @akrabat, the "3.0.0" verbiage needed to be on the same line as the
  annotation.
@weierophinney
Copy link
Member Author

Discussed triggering E_USER_DEPRECATED with @akrabat, and decided not to do so, as it prematurely breaks a lot of code. (I observed this elsewhere in Apigility when ZF components triggered such errors, causing API payloads to break when display_errors is on — which is often useful in development!)

@akrabat
Copy link
Contributor

akrabat commented Sep 29, 2015

Looks good to me.

@weierophinney weierophinney merged commit 4aa14b5 into zendframework:master Sep 29, 2015
weierophinney added a commit that referenced this pull request Sep 29, 2015
weierophinney added a commit that referenced this pull request Sep 29, 2015
weierophinney added a commit that referenced this pull request Sep 29, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants