class Notification extends Facade

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container|null $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

from  Facade
static protected array<string, int> $coroutineAccessors

Accessors with coroutine-local roots, and their current generation.

from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static MockInterface|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static void
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

from  Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
fake()

Replace the bound instance with a fake.

routes(array $channels)

Begin sending a notification to an anonymous notifiable on the given channels.

route(string $channel, mixed $route)

Begin sending a notification to an anonymous notifiable.

static mixed
channel(UnitEnum|string|null $name = 'null')

No description

static string
deliversVia()

No description

static void
deliverVia(string $channel)

No description

static mixed
driver(UnitEnum|string|null $driver = 'null')

No description

static ChannelManager
extend(string $driver, Closure $callback)

No description

static void
flushMacros()

No description

static void
flushState()

No description

static ChannelManager
forgetDrivers()

No description

static Container
getContainer()

No description

static string
getDefaultDriver()

No description

static void
array()

<array-key, mixed> getDrivers()

static string|null
getLocale()

No description

static bool
hasMacro(string $name)

No description

static ChannelManager
locale(string $locale)

No description

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

No description

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

No description

static string|null
resolveConnectionFromQueueRoute(object $queueable, UnitEnum $queue = 'null')

No description

static string|null
resolveQueueFromQueueRoute(object $queueable)

No description

static void
send(mixed $notifiables, mixed $notification)

No description

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

No description

static ChannelManager
setContainer(Container $container)

No description

static void
assertCount(int $expectedCount)

No description

static void
assertNothingSent()

No description

static void
assertNothingSentTo(mixed $notifiable)

No description

static void
assertNotSentTo(mixed $notifiable, Closure|string $notification, null|array<string $, mixed>|callable $callback = 'null')

No description

static void
assertSentOnDemand(Closure|string $notification, null|array<string $, mixed>|callable $callback = 'null')

No description

static void
assertSentOnDemandOnce(string $notification)

No description

static void
assertSentOnDemandTimes(string $notification, int $times = '1')

No description

static void
assertSentTimes(string $notification, int $expectedCount)

No description

static void
assertSentTo(mixed $notifiable, Closure|string $notification, null|array<string $, mixed>|callable|int $callback = 'null')

No description

static void
assertSentToOnce(mixed $notifiable, string $notification)

No description

static void
assertSentToTimes(mixed $notifiable, string $notification, int $times = '1')

No description

static bool
hasSent(mixed $notifiable, string $notification)

No description

static Collection
sent(mixed $notifiable, string $notification, null|array<string $, mixed>|callable $callback = 'null')

No description

static array
sentNotifications()

No description

serializeAndRestore(bool $serializeAndRestore = 'true')

No description

Details

in Facade at line 85
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 106
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 125
static MockInterface partialMock()

Initiate a partial mock on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 142
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 159
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 176
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 199
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 210
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 226
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 239
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 250
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 93
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 266
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 312
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Later facade calls everywhere resolve again; only references already held keep the previous instance.

Parameters

string|null $name

Return Value

void

in Facade at line 330
static void clearResolvedInstances()

Clear all of the resolved instances.

Later facade calls everywhere resolve again; only references already held keep the previous instances.

Return Value

void

in Facade at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 404
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 415
static void setFacadeApplication(Container|null $app)

Set the application instance.

Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

in Facade at line 427
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException
Throwable

at line 60
static NotificationFake fake()

Replace the bound instance with a fake.

Swaps the resolved facade instance for the worker lifetime.

Return Value

NotificationFake

at line 71
static AnonymousNotifiable routes(array $channels)

Begin sending a notification to an anonymous notifiable on the given channels.

Parameters

array $channels

Return Value

AnonymousNotifiable

at line 85
static AnonymousNotifiable route(string $channel, mixed $route)

Begin sending a notification to an anonymous notifiable.

Parameters

string $channel
mixed $route

Return Value

AnonymousNotifiable

at line 53
static mixed channel(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

mixed

at line 53
static string deliversVia()

No description

Return Value

string

at line 53
static void deliverVia(string $channel)

No description

Parameters

string $channel

Return Value

void

at line 53
static mixed driver(UnitEnum|string|null $driver = 'null')

No description

Parameters

UnitEnum|string|null $driver

Return Value

mixed

at line 53
static ChannelManager extend(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

ChannelManager

at line 53
static void flushMacros()

No description

Return Value

void

at line 53
static void flushState()

No description

Return Value

void

at line 53
static ChannelManager forgetDrivers()

No description

Return Value

ChannelManager

at line 53
static Container getContainer()

No description

Return Value

Container

at line 53
static string getDefaultDriver()

No description

Return Value

string

at line 53
static void array()

<array-key, mixed> getDrivers()

Return Value

void

at line 53
static string|null getLocale()

No description

Return Value

string|null

at line 53
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 53
static ChannelManager locale(string $locale)

No description

Parameters

string $locale

Return Value

ChannelManager

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 53
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 53
static string|null resolveConnectionFromQueueRoute(object $queueable, UnitEnum $queue = 'null')

No description

Parameters

object $queueable
UnitEnum $queue

Return Value

string|null

at line 53
static string|null resolveQueueFromQueueRoute(object $queueable)

No description

Parameters

object $queueable

Return Value

string|null

at line 53
static void send(mixed $notifiables, mixed $notification)

No description

Parameters

mixed $notifiables
mixed $notification

Return Value

void

at line 53
static void sendNow(mixed $notifiables, mixed $notification, array|null $channels = 'null')

No description

Parameters

mixed $notifiables
mixed $notification
array|null $channels

Return Value

void

at line 53
static ChannelManager setContainer(Container $container)

No description

Parameters

Container $container

Return Value

ChannelManager

at line 53
static void assertCount(int $expectedCount)

No description

Parameters

int $expectedCount

Return Value

void

at line 53
static void assertNothingSent()

No description

Return Value

void

at line 53
static void assertNothingSentTo(mixed $notifiable)

No description

Parameters

mixed $notifiable

Return Value

void

at line 53
static void assertNotSentTo(mixed $notifiable, Closure|string $notification, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

mixed $notifiable
Closure|string $notification
null|array<string $
mixed>|callable $callback

Return Value

void

at line 53
static void assertSentOnDemand(Closure|string $notification, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

Closure|string $notification
null|array<string $
mixed>|callable $callback

Return Value

void

at line 53
static void assertSentOnDemandOnce(string $notification)

No description

Parameters

string $notification

Return Value

void

at line 53
static void assertSentOnDemandTimes(string $notification, int $times = '1')

No description

Parameters

string $notification
int $times

Return Value

void

at line 53
static void assertSentTimes(string $notification, int $expectedCount)

No description

Parameters

string $notification
int $expectedCount

Return Value

void

at line 53
static void assertSentTo(mixed $notifiable, Closure|string $notification, null|array<string $, mixed>|callable|int $callback = 'null')

No description

Parameters

mixed $notifiable
Closure|string $notification
null|array<string $
mixed>|callable|int $callback

Return Value

void

at line 53
static void assertSentToOnce(mixed $notifiable, string $notification)

No description

Parameters

mixed $notifiable
string $notification

Return Value

void

at line 53
static void assertSentToTimes(mixed $notifiable, string $notification, int $times = '1')

No description

Parameters

mixed $notifiable
string $notification
int $times

Return Value

void

at line 53
static bool hasSent(mixed $notifiable, string $notification)

No description

Parameters

mixed $notifiable
string $notification

Return Value

bool

at line 53
static Collection sent(mixed $notifiable, string $notification, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

mixed $notifiable
string $notification
null|array<string $
mixed>|callable $callback

Return Value

Collection

at line 53
static array sentNotifications()

No description

Return Value

array

at line 53
static NotificationFake serializeAndRestore(bool $serializeAndRestore = 'true')

No description

Parameters

bool $serializeAndRestore

Return Value

NotificationFake