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

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

__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
Container
getContainer()

Get the container instance used by the manager.

from  Manager
$this
setContainer(Container $container)

Set the container instance used by the manager.

from  Manager
$this
forgetDrivers()

Forget all of the resolved driver instances.

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|null $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

in Manager at line 44
__construct(Container $container)

Create a new manager instance.

Parameters

Container $container

at line 124
string getDefaultDriver()

Get the default channel driver name.

Return Value

string

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

Get a driver instance.

Parameters

string|null $driver

Return Value

mixed

Exceptions

InvalidArgumentException

at line 106
protected mixed createDriver(string $driver)

Create a new driver instance.

Parameters

string $driver

Return Value

mixed

Exceptions

InvalidArgumentException

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

Call a custom driver creator.

Parameters

string $driver

Return Value

mixed

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

Register a custom driver creator Closure.

Parameters

string $driver
Closure $callback

Return Value

$this

in Manager at line 141
array getDrivers()

Get all of the created "drivers".

Return Value

array

in Manager at line 151
Container getContainer()

Get the container instance used by the manager.

Return Value

Container

in Manager at line 162
$this setContainer(Container $container)

Set the container instance used by the manager.

Parameters

Container $container

Return Value

$this

in Manager at line 174
$this forgetDrivers()

Forget all of the resolved driver instances.

Return Value

$this

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

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

at line 35
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 50
void sendNow(Collection|array|mixed $notifiables, mixed $notification, array|null $channels = null)

Send the given notification immediately.

Parameters

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

Return Value

void

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

Get a channel instance.

Parameters

string|null $name

Return Value

mixed

at line 73
protected DatabaseChannel createDatabaseDriver()

Create an instance of the database driver.

Return Value

DatabaseChannel

at line 83
protected BroadcastChannel createBroadcastDriver()

Create an instance of the broadcast driver.

Return Value

BroadcastChannel

at line 93
protected MailChannel createMailDriver()

Create an instance of the mail driver.

Return Value

MailChannel

at line 134
string deliversVia()

Get the default channel driver name.

Return Value

string

at line 145
void deliverVia(string $channel)

Set the default channel driver name.

Parameters

string $channel

Return Value

void

at line 156
$this locale(string $locale)

Set the locale of notifications.

Parameters

string $locale

Return Value

$this