[12.x] Add Reverb events documentation #10954
Open
+63
−0
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.
This PR adds a new "Events" section to the Reverb documentation. It details the internal events dispatched by the server (such as
ChannelCreated,ChannelRemoved,MessageReceived, etc.) and provides examples of how to listen to them using standard Laravel listeners.While integrating Reverb, I needed to perform specific actions during the channel opening and closing lifecycle.
I noticed that the current documentation does not explicitly mention that Reverb dispatches these internal events. This lack of visibility has led to some confusion in the community. For instance, in Issue #185, developers were discussing complex workarounds—such as extending the core
Serverclass—to manually dispatch events, unaware that Reverb already handles this natively.By documenting these events, we can encourage best practices and prevent developers from overwriting core classes unnecessarily.
Related discussion: laravel/reverb#185