README

Automatically register channel routes using annotations/attributes!

This package is inspired by spatie/laravel-route-attributes.

Already using spatie/laravel-route-attributes? Congrats, time to ditch that ./routes directory! (Assuming you're not using the console.php)

use JulioMotol\ChannelAttributes\Attributes\Channel;

#[Channel('foo')]
class FooChannel
{
    //
}

This will be registered like:

Broadcast::channel('foo', FooChannel::class);

Installation

You can install the package via composer:

composer require juliomotol/laravel-channel-attributes

You can publish the config file with:

php artisan vendor:publish --tag="laravel-channel-attributes-config"

This is the contents of the published config file:

return [
    /*
     *  Automatic registration of channels will only happen if this setting is `true`
     */
    'enabled' => true,

    /*
     * Channels in these directories that have channel attributes will automatically be registered.
     * You can specify a different namespace other than `\App` by providing a different key.
     *
     * e.g ['\Domain\Post\Broadcasting' => base_path('domain/Post/Broadcasting')]
     */
    'directories' => [
        app_path('Broadcasting'),
    ],
];

Usage

To add a channel to be registered automatically, simply add the JulioMotol\ChannelAttributes\Attributes\Channel to a channel class

Code	Will be interpreted as:
use JulioMotol\ChannelAttributes\Attributes\Channel; #[Channel('foo')] class FooChannel { // }	`Broadcast::channel('foo', FooChannel::class);`

You can add options to channel by doing:

Code	Will be interpreted as:
use JulioMotol\ChannelAttributes\Attributes\Channel; #[Channel('foo', ['guard' => 'web'])] class FooChannel { // }	`Broadcast::channel('foo', FooChannel::class, ['guard' => 'web']);`

You can create a channel for a model by doing:

Code	Will be interpreted as:
use JulioMotol\ChannelAttributes\Attributes\Channel; use App\Models\Post; #[Channel(Post::class)] class FooChannel { // }	`Broadcast::channel(Post::class, FooChannel::class);`

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

juliomotol / laravel-channel-attributes

Maintainers

Details