README

A lightweight and powerful package to intercept and hook into Laravel Reverb server events with ease.

This package allows you to listen to channel creation, message delivery, and connection lifecycle events using a clean, fluent API.

Requirements

PHP 8.2 or higher
Laravel 11.x or 12.x
Laravel Reverb

Installation

You can install the package via composer:

composer require julioccorreia/reverb-hooks

Usage

The best place to register your hooks is in the boot method of your AppServiceProvider or a dedicated EventServiceProvider.

Channel Hooks

You can listen to when channels are created or removed. Supports wildcards for flexible filtering.

use JulioCCorreia\ReverbHooks\Facades\ReverbHooks;

// Listen to any channel creation
ReverbHooks::onChannelCreated(function ($event) {
    Log::info("Channel created: {$event->channel->name()}");
});

// Listen to specific channels using wildcards
ReverbHooks::onChannelCreated('chat.*', function ($event) {
    // This only triggers for channels starting with 'chat.'
});

Message Hooks

Intercept messages as they flow through the Reverb server.

// Triggers when a message is successfully sent to a channel
ReverbHooks::onMessageSent('orders.*', function ($event) {
    // Perfect for logging or metrics
});

// Triggers when any raw message is received by the server
ReverbHooks::onMessageReceived(function ($event) {
    // Low-level access to the incoming payload
});

Connection Hooks

Monitor the health of your WebSocket server.

// Triggers when a stale connection is pruned by the server
ReverbHooks::onConnectionPruned(function ($event) {
    Log::warning("Connection pruned for user: {$event->connection->identifier()}");
});

Available

Method	Description
onChannelCreated($channels, $callback)	Triggered when a new channel is instantiated.
onChannelRemoved($channels, $callback)	Triggered when a channel is destroyed.
onMessageSent($channels, $callback)	Triggered after a message is broadcasted.
onMessageReceived($callback)	Triggered upon receiving a raw message from a client.
onConnectionPruned($callback)	Triggered when the server cleans up an inactive connection.

Development & Quality

This package maintains high code quality standards:

PHPStan: Analyzed at Level 9 for maximum type safety.
Laravel Pint: Follows the official Laravel coding style.
Rector: Automated code refactoring for modern PHP features.
Strict Types: All files use declare(strict_types=1).

Testing

You can run the tests using Pest:

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

Júlio César Correia Gazige

License

The MIT License (MIT). Please see License File for more information.

julioccorreia / reverb-hooks

Maintainers

Details