W3cubDocs

/Laravel 8

ChannelManager

class ChannelManager extends Manager implements Dispatcher, Factory (View source)

Properties

protected Container $container The container instance. from Manager
protected Repository $config The configuration repository instance. from Manager
protected array $customCreators The registered custom driver creators. from Manager
protected array $drivers The array of created "drivers". from Manager
protected string $defaultChannel The default channel used to deliver messages.
protected string|null $locale The locale used when sending notifications.

Methods

void __construct(Container $container)

Create a new manager instance.

 from Manager
string getDefaultDriver()

Get the default channel driver name.
mixed driver(string|null $driver = null)

Get a driver instance.

 from Manager
mixed createDriver(string $driver)

Create a new driver instance.
mixed callCustomCreator(string $driver)

Call a custom driver creator.

 from Manager
$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

 from Manager
array getDrivers()

Get all of the created "drivers".

 from Manager
mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

 from Manager
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 $channels = null)

Send the given notification immediately.
mixed channel(string|null $name = null)

Get a channel instance.
DatabaseChannel createDatabaseDriver()

Create an instance of the database driver.
BroadcastChannel createBroadcastDriver()

Create an instance of the broadcast driver.
MailChannel createMailDriver()

Create an instance of the mail driver.
string deliversVia()

Get the default channel driver name.
void deliverVia(string $channel)

Set the default channel driver name.
$this locale(string $locale)

Set the locale of notifications.

Details

void __construct(Container $container)

Create a new manager instance.

Parameters

Container $container

Return Value

void

string getDefaultDriver()

Get the default channel driver name.

Return Value

string

mixed driver(string|null $driver = null)

Get a driver instance.

Parameters

string|null $driver

Return Value

mixed

Exceptions

InvalidArgumentException

protected mixed createDriver(string $driver)

Create a new driver instance.

Parameters

string $driver

Return Value

mixed

Exceptions

InvalidArgumentException

protected mixed callCustomCreator(string $driver)

Call a custom driver creator.

Parameters

string $driver

Return Value

mixed

$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Parameters

string $driver
Closure $callback

Return Value

$this

array getDrivers()

Get all of the created "drivers".

Return Value

array

mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

void send(Collection|array|mixed $notifiables, mixed $notification)

Send the given notification to the given notifiable entities.

Parameters

Collection|array|mixed $notifiables
mixed $notification

Return Value

void

void sendNow(Collection|array|mixed $notifiables, mixed $notification, array $channels = null)

Send the given notification immediately.

Parameters

Collection|array|mixed $notifiables
mixed $notification
array $channels

Return Value

void

mixed channel(string|null $name = null)

Get a channel instance.

Parameters

string|null $name

Return Value

mixed

protected DatabaseChannel createDatabaseDriver()

Create an instance of the database driver.

Return Value

DatabaseChannel

protected BroadcastChannel createBroadcastDriver()

Create an instance of the broadcast driver.

Return Value

BroadcastChannel

protected MailChannel createMailDriver()

Create an instance of the mail driver.

Return Value

MailChannel

string deliversVia()

Get the default channel driver name.

Return Value

string

void deliverVia(string $channel)

Set the default channel driver name.

Parameters

string $channel

Return Value

void

$this locale(string $locale)

Set the locale of notifications.

Parameters

string $locale

Return Value

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Notifications/ChannelManager.html