Add examples to showcase how to stop events #5106
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
markstory
reviewed
Jul 18, 2017
en/orm/table-objects.rst
Outdated
| stopping this event you will abort the delete operation. | ||
| stopping this event you will abort the delete operation. When the event is stopped the result | ||
| of the event will be returned. | ||
| Stopping the event works like this:: |
Member
There was a problem hiding this comment.
Should we link to the relevant section in the events docs instead?
Member
Author
There was a problem hiding this comment.
That could be an option, too. It would be this link, right? https://book.cakephp.org/3.0/en/core-libraries/events.html#stopping-events
I hope it's obvious how to call it than 😀
Member
There was a problem hiding this comment.
Yes, that looks like a good place to link to.
ravage84
approved these changes
Jul 19, 2017
en/orm/table-objects.rst
Outdated
|
|
||
| public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $options) | ||
| { | ||
| ... |
Member
There was a problem hiding this comment.
// ...
Just for the lazyp people copying stuff 1:1 😆
en/orm/table-objects.rst
Outdated
| { | ||
| ... | ||
| $event->stopPropagation(); | ||
| ... |
okinaka
added a commit
to okinaka/docs
that referenced
this pull request
Jul 26, 2017
HavokInspiration
added a commit
that referenced
this pull request
Jul 29, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I added an example on how to stop the event, as I saw/got that question a few times lately.