Events
Minimize the number of traits
By default, Laravel adds few traits to a new Event class, even if it’s not needed in your particular case. It’s still better to control traits more explicitly.
PHP
- use Dispatchable, InteractsWithSockets, SerializesModels;
+ use SerializesModels; // only if the Event will be used with Queued Event Listeners
Explanation:
Dispatchableis to add static methods to simplify event dispatching, likeYourEvent::dispatch(). We do not use this syntax, so we don’t need this trait. Please use\Illuminate\Support\Facades\Eventfacade instead, e.g.Event::dispatch(new YourEvent()).SerializesModelsis to gracefully serialize any Eloquent models if the event object contains Eloquent models and going to be serialized using PHP's serialize function, such as when utilizing queued listeners.InteractsWithSocketsis for broadcasting only, e.g. using Laravel Echo.
Best Practices:
- Tailor Event class traits based on specific needs rather than using the default set.
- Understand the implications of each trait to avoid unnecessary overhead or missing functionality.
- Event class should be
final readonly
