make:event --broadcast

[khalyomede]

Currently by default when you do not customize Laravel's stubs, you have this when creating a new event through artisan make:event:

namespace App\Events;

use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class ShoppingListMemberLeft
{
  use Dispatchable, InteractsWithSockets, SerializesModels;

  /**
   * Create a new event instance.
   */
  public function __construct()
  {
    //
  }

  /**
   * Get the channels the event should broadcast on.
   *
   * @return array<int, \Illuminate\Broadcasting\Channel>
   */
  public function broadcastOn(): array
  {
    return [
      new PrivateChannel('channel-name'),
    ];
  }
}

I humbly think (no data about it sorry) Event/Listeners pattern is not primarily used to send real time events. I like this pattern to lighten my controllers and put every asynchronous tasks inside of it, or even synchronous tasks when it helps make the code more readable/reusable across different controllers/commands.

I propose by default that the events are brodcast-less, and we can specify if we want a brodcastable event behind a flag.

By default

php artisan make:event ShoppingListMemberLeft

<?php

namespace App\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class ShoppingListMemberLeft
{
  use Dispatchable, SerializesModels;

  /**
   * Create a new event instance.
   */
  public function __construct()
  {
    //
  }
}

Brodcastable event

php artisan make:event --brodcast ShoppingListMemberLeft

namespace App\Events;

use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class ShoppingListMemberLeft
{
  use Dispatchable, InteractsWithSockets, SerializesModels;

  /**
   * Create a new event instance.
   */
  public function __construct()
  {
    //
  }

  /**
   * Get the channels the event should broadcast on.
   *
   * @return array<int, \Illuminate\Broadcasting\Channel>
   */
  public function broadcastOn(): array
  {
    return [
      new PrivateChannel('channel-name'),
    ];
  }
}