class Broadcast 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
static AblyRest
ably(array $config)

No description

addPoolableDriver(string $driver)

No description

static void
channelRoutes(array|null $attributes = 'null')

No description

static Broadcaster
connection(UnitEnum|string|null $name = 'null')

No description

static Broadcaster
driver(UnitEnum|string|null $name = 'null')

No description

event(mixed $event = 'null')

No description

extend(string $driver, Closure $callback)

No description

forgetDrivers()

No description

static Container
getApplication()

No description

static string
getDefaultDriver()

No description

static array
getPoolableDrivers()

No description

static Closure|null
getReleaseCallback(string $driver)

No description

static HubInterface
mercure(array $config)

No description

static AnonymousEvent
on(Channel|array|string $channels)

No description

static AnonymousEvent
presence(string $channel)

No description

static AnonymousEvent
private(string $channel)

No description

static void
purge(UnitEnum|string|null $name = 'null')

No description

static Pusher
pusher(array $config)

No description

static void
queue(mixed $event)

No description

removePoolableDriver(string $driver)

No description

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

No description

static string|null
resolveQueueFromQueueRoute(object $queueable)

No description

static void
routes(array|null $attributes = 'null')

No description

setApplication(Container $app)

No description

static void
setDefaultDriver(UnitEnum|string $name)

No description

setPoolableDrivers(array $poolableDrivers)

No description

setReleaseCallback(string $driver, Closure $callback)

No description

static string|null
socket(Request|null $request = 'null')

No description

static void
userRoutes(array|null $attributes = 'null')

No description

static mixed
auth(Request $request)

No description

static void
authorizeChannelsUsing(Closure|null $callback)

No description

static void
broadcast(array $channels, string $event, array $payload = '[]')

No description

static Broadcaster
channel(HasBroadcastChannel|string $channel, callable|string $callback, array $options = '[]')

No description

static Closure|null
channelFormatter()

No description

static void
flushState()

No description

static void
formatChannelsUsing(Closure|null $callback)

No description

static Collection
getChannels()

No description

static array|null
resolveAuthenticatedUser(Request $request)

No description

static void
resolveAuthenticatedUserUsing(Closure|null $callback)

No description

static mixed
validAuthenticationResponse(Request $request, mixed $result)

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 59
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 54
static AblyRest ably(array $config)

No description

Parameters

array $config

Return Value

AblyRest

at line 54
static BroadcastManager addPoolableDriver(string $driver)

No description

Parameters

string $driver

Return Value

BroadcastManager

at line 54
static void channelRoutes(array|null $attributes = 'null')

No description

Parameters

array|null $attributes

Return Value

void

at line 54
static Broadcaster connection(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

Broadcaster

at line 54
static Broadcaster driver(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

Broadcaster

at line 54
static PendingBroadcast event(mixed $event = 'null')

No description

Parameters

mixed $event

Return Value

PendingBroadcast

at line 54
static BroadcastManager extend(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

BroadcastManager

at line 54
static BroadcastManager forgetDrivers()

No description

Return Value

BroadcastManager

at line 54
static Container getApplication()

No description

Return Value

Container

at line 54
static string getDefaultDriver()

No description

Return Value

string

at line 54
static array getPoolableDrivers()

No description

Return Value

array

at line 54
static Closure|null getReleaseCallback(string $driver)

No description

Parameters

string $driver

Return Value

Closure|null

at line 54
static HubInterface mercure(array $config)

No description

Parameters

array $config

Return Value

HubInterface

at line 54
static AnonymousEvent on(Channel|array|string $channels)

No description

Parameters

Channel|array|string $channels

Return Value

AnonymousEvent

at line 54
static AnonymousEvent presence(string $channel)

No description

Parameters

string $channel

Return Value

AnonymousEvent

at line 54
static AnonymousEvent private(string $channel)

No description

Parameters

string $channel

Return Value

AnonymousEvent

at line 54
static void purge(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

void

at line 54
static Pusher pusher(array $config)

No description

Parameters

array $config

Return Value

Pusher

at line 54
static void queue(mixed $event)

No description

Parameters

mixed $event

Return Value

void

at line 54
static BroadcastManager removePoolableDriver(string $driver)

No description

Parameters

string $driver

Return Value

BroadcastManager

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

No description

Parameters

object $queueable
UnitEnum $queue

Return Value

string|null

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

No description

Parameters

object $queueable

Return Value

string|null

at line 54
static void routes(array|null $attributes = 'null')

No description

Parameters

array|null $attributes

Return Value

void

at line 54
static BroadcastManager setApplication(Container $app)

No description

Parameters

Container $app

Return Value

BroadcastManager

at line 54
static void setDefaultDriver(UnitEnum|string $name)

No description

Parameters

UnitEnum|string $name

Return Value

void

at line 54
static BroadcastManager setPoolableDrivers(array $poolableDrivers)

No description

Parameters

array $poolableDrivers

Return Value

BroadcastManager

at line 54
static BroadcastManager setReleaseCallback(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

BroadcastManager

at line 54
static string|null socket(Request|null $request = 'null')

No description

Parameters

Request|null $request

Return Value

string|null

at line 54
static void userRoutes(array|null $attributes = 'null')

No description

Parameters

array|null $attributes

Return Value

void

at line 54
static mixed auth(Request $request)

No description

Parameters

Request $request

Return Value

mixed

at line 54
static void authorizeChannelsUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

void

at line 54
static void broadcast(array $channels, string $event, array $payload = '[]')

No description

Parameters

array $channels
string $event
array $payload

Return Value

void

at line 54
static Broadcaster channel(HasBroadcastChannel|string $channel, callable|string $callback, array $options = '[]')

No description

Parameters

HasBroadcastChannel|string $channel
callable|string $callback
array $options

Return Value

Broadcaster

at line 54
static Closure|null channelFormatter()

No description

Return Value

Closure|null

at line 54
static void flushState()

No description

Return Value

void

at line 54
static void formatChannelsUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

void

at line 54
static Collection getChannels()

No description

Return Value

Collection

at line 54
static array|null resolveAuthenticatedUser(Request $request)

No description

Parameters

Request $request

Return Value

array|null

at line 54
static void resolveAuthenticatedUserUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

void

at line 54
static mixed validAuthenticationResponse(Request $request, mixed $result)

No description

Parameters

Request $request
mixed $result

Return Value

mixed