1. class
  2. Illuminate
  3. \
  4. Notifications
  5. \
  6. ChannelManager

ChannelManager

class ChannelManager extends Manager implements Dispatcher, Factory

Properties

protected Application $app

The application 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.

Methods

void
__construct(Application $app)

Create a new manager instance.

from  Manager
string
getDefaultDriver()

Get the default channel driver name.

mixed
driver(string $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.

NexmoSmsChannel
createNexmoDriver()

Create an instance of the Nexmo driver.

SlackWebhookChannel
createSlackDriver()

Create an instance of the Slack driver.

string
deliversVia()

Get the default channel driver name.

void
deliverVia(string $channel)

Set the default channel driver name.

Details

in Manager at line 37
void __construct(Application $app)

Create a new manager instance.

Parameters

Application $app

Return Value

void

at line 149
string getDefaultDriver()

Get the default channel driver name.

Return Value

string

in Manager at line 55
mixed driver(string $driver = null)

Get a driver instance.

Parameters

string $driver

Return Value

mixed

at line 131
protected mixed createDriver(string $driver)

Create a new driver instance.

Parameters

string $driver

Return Value

mixed

Exceptions

InvalidArgumentException

in Manager at line 100
protected mixed callCustomCreator(string $driver)

Call a custom driver creator.

Parameters

string $driver

Return Value

mixed

in Manager at line 112
$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Parameters

string $driver
Closure $callback

Return Value

$this

in Manager at line 124
array getDrivers()

Get all of the created "drivers".

Return Value

array

in Manager at line 136
mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

at line 32
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

at line 47
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

at line 60
mixed channel(string|null $name = null)

Get a channel instance.

Parameters

string|null $name

Return Value

mixed

at line 70
protected DatabaseChannel createDatabaseDriver()

Create an instance of the database driver.

Return Value

DatabaseChannel

at line 80
protected BroadcastChannel createBroadcastDriver()

Create an instance of the broadcast driver.

Return Value

BroadcastChannel

at line 90
protected MailChannel createMailDriver()

Create an instance of the mail driver.

Return Value

MailChannel

at line 102
protected NexmoSmsChannel createNexmoDriver()

Create an instance of the Nexmo driver.

Return Value

NexmoSmsChannel

at line 118
protected SlackWebhookChannel createSlackDriver()

Create an instance of the Slack driver.

Return Value

SlackWebhookChannel

at line 159
string deliversVia()

Get the default channel driver name.

Return Value

string

at line 170
void deliverVia(string $channel)

Set the default channel driver name.

Parameters

string $channel

Return Value

void