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

Traits

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
static protected array $macros

The registered string macros.

from  Macroable
protected NotificationSender|null $notificationSender

The resolved notification sender instance.

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|null
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
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 handle calls to the class.

static void
macro(string $name, object|callable $macro)

Register a custom macro.

static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

static bool
hasMacro(string $name)

Checks if macro is registered.

static void
flushMacros()

Flush the existing macros.

static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

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

Send the given notification to the given notifiable entities.

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

Send the given notification immediately.

mixed
channel(string|null $name = null)

Get a channel instance.

createDatabaseDriver()

Create an instance of the database driver.

createBroadcastDriver()

Create an instance of the broadcast driver.

createMailDriver()

Create an instance of the mail driver.

resolveNotificationSender()

Resolve the NotificationSender instance.

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

__construct(Container $container)

Create a new manager instance.

Parameters

Container $container

string|null getDefaultDriver()

Get the default channel driver name.

Return Value

string|null

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

Container getContainer()

Get the container instance used by the manager.

Return Value

Container

$this setContainer(Container $container)

Set the container instance used by the manager.

Parameters

Container $container

Return Value

$this

$this forgetDrivers()

Forget all of the resolved driver instances.

Return Value

$this

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Send the given notification to the given notifiable entities.

Parameters

Collection|mixed $notifiables
mixed $notification

Return Value

void

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

Send the given notification immediately.

Parameters

Collection|mixed $notifiables
mixed $notification
array|null $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

protected NotificationSender resolveNotificationSender()

Resolve the NotificationSender instance.

Return Value

NotificationSender

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