class Broadcast extends Facade (View source)

Properties

static protected Application|null $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

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
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static Expectation
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static Expectation
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 $name)

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 Application|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|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 void
routes(array|null $attributes = null)

No description

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

No description

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

No description

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

No description

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

No description

static AnonymousEvent
private(string $channel)

No description

static AnonymousEvent
presence(string $channel)

No description

event(mixed|null $event = null)

No description

static void
queue(mixed $event)

No description

static mixed
connection(string|null $driver = null)

No description

static mixed
driver(string|null $name = null)

No description

static Pusher
pusher(array $config)

No description

static AblyRest
ably(array $config)

No description

static string
getDefaultDriver()

No description

static void
setDefaultDriver(string $name)

No description

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

No description

extend(string $driver, Closure $callback)

No description

static Application
getApplication()

No description

setApplication(Application $app)

No description

forgetDrivers()

No description

static mixed
auth(Request $request)

No description

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

No description

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

No description

static array|null
resolveAuthenticatedUser(Request $request)

No description

static void
resolveAuthenticatedUserUsing(Closure $callback)

No description

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

No description

static Collection
getChannels()

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

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

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

static bool isFake()

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

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

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

No description

Parameters

array|null $attributes

Return Value

void

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

No description

Parameters

array|null $attributes

Return Value

void

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

No description

Parameters

array|null $attributes

Return Value

void

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

No description

Parameters

Request|null $request

Return Value

string|null

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

No description

Parameters

Channel|array|string $channels

Return Value

AnonymousEvent

static AnonymousEvent private(string $channel)

No description

Parameters

string $channel

Return Value

AnonymousEvent

static AnonymousEvent presence(string $channel)

No description

Parameters

string $channel

Return Value

AnonymousEvent

static PendingBroadcast event(mixed|null $event = null)

No description

Parameters

mixed|null $event

Return Value

PendingBroadcast

static void queue(mixed $event)

No description

Parameters

mixed $event

Return Value

void

static mixed connection(string|null $driver = null)

No description

Parameters

string|null $driver

Return Value

mixed

static mixed driver(string|null $name = null)

No description

Parameters

string|null $name

Return Value

mixed

static Pusher pusher(array $config)

No description

Parameters

array $config

Return Value

Pusher

static AblyRest ably(array $config)

No description

Parameters

array $config

Return Value

AblyRest

static string getDefaultDriver()

No description

Return Value

string

static void setDefaultDriver(string $name)

No description

Parameters

string $name

Return Value

void

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

No description

Parameters

string|null $name

Return Value

void

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

No description

Parameters

string $driver
Closure $callback

Return Value

BroadcastManager

static Application getApplication()

No description

Return Value

Application

static BroadcastManager setApplication(Application $app)

No description

Parameters

Application $app

Return Value

BroadcastManager

static BroadcastManager forgetDrivers()

No description

Return Value

BroadcastManager

static mixed auth(Request $request)

No description

Parameters

Request $request

Return Value

mixed

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

No description

Parameters

Request $request
mixed $result

Return Value

mixed

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

No description

Parameters

array $channels
string $event
array $payload

Return Value

void

static array|null resolveAuthenticatedUser(Request $request)

No description

Parameters

Request $request

Return Value

array|null

static void resolveAuthenticatedUserUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

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

static Collection getChannels()

No description

Return Value

Collection