NotificationSender
class NotificationSender (View source)
Traits
Properties
| protected ChannelManager | $manager | The notification manager instance. |
|
| protected Dispatcher | $bus | The Bus dispatcher instance. |
|
| protected Dispatcher | $events | The event dispatcher. |
|
| protected string|null | $locale | The locale to be used when sending notifications. |
Methods
Create a new notification sender instance.
Send the given notification to the given notifiable entities.
Send the given notification immediately.
Get the notifiable's preferred locale for the notification.
Send the given notification to the given notifiable via a channel.
Determines if the notification can be sent.
Queue the given notification instances.
Format the notifiables into a Collection / array if necessary.
Details
mixed
withLocale(string $locale, Closure $callback)
Run the callback with the given locale.
void
__construct(ChannelManager $manager, Dispatcher $bus, Dispatcher $events, string|null $locale = null)
Create a new notification sender instance.
void
send(Collection|array|mixed $notifiables, mixed $notification)
Send the given notification to the given notifiable entities.
void
sendNow(Collection|array|mixed $notifiables, mixed $notification, array|null $channels = null)
Send the given notification immediately.
protected string|null
preferredLocale(mixed $notifiable, mixed $notification)
Get the notifiable's preferred locale for the notification.
protected void
sendToNotifiable(mixed $notifiable, string $id, mixed $notification, string $channel)
Send the given notification to the given notifiable via a channel.
protected bool
shouldSendNotification(mixed $notifiable, mixed $notification, string $channel)
Determines if the notification can be sent.
protected void
queueNotification(mixed $notifiables, Notification $notification)
Queue the given notification instances.
protected Collection|array
formatNotifiables(mixed $notifiables)
Format the notifiables into a Collection / array if necessary.