Event

class Event extends Facade (View source)

Properties

static protected Application	$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

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Application $app)

Set the application instance.

from Facade

static mixed

__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from Facade

static EventFake

fake(array|string $eventsToFake = [])

Replace the bound instance with a fake.

static EventFake

fakeExcept(string[]|string $eventsToAllow)

Replace the bound instance with a fake that fakes all events except the given events.

static mixed

fakeFor(callable $callable, array $eventsToFake = [])

Replace the bound instance with a fake during the given callable's execution.

static mixed

fakeExceptFor(callable $callable, array $eventsToAllow = [])

Replace the bound instance with a fake during the given callable's execution.

static void

No description

static bool

hasListeners(string $eventName)

No description

static bool

hasWildcardListeners(string $eventName)

No description

static void

push(string $event, object|array $payload = [])

No description

static void

flush(string $event)

No description

static void

subscribe(object|string $subscriber)

No description

static array|null

until(string|object $event, mixed $payload = [])

No description

static array|null

dispatch(string|object $event, mixed $payload = [], bool $halt = false)

No description

static array

getListeners(string $eventName)

No description

static Closure

makeListener(Closure|string|array $listener, bool $wildcard = false)

No description

static Closure

createClassListener(string $listener, bool $wildcard = false)

No description

static void

forget(string $event)

No description

static void

forgetPushed()

No description

static Dispatcher

setQueueResolver(callable $resolver)

No description

static array

getRawListeners()

No description

static void

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

No description

static void

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

No description

static bool

hasMacro(string $name)

No description

static void

flushMacros()

No description

static EventFake

except(array|string $eventsToDispatch)

No description

static void

assertListening(string $expectedEvent, string|array $expectedListener)

No description

static void

assertDispatched(Closure $event, callable|int|null $callback = null)

No description

static void

assertDispatchedTimes(string $event, int $times = 1)

No description

static void

assertNotDispatched(Closure $event, callable|null $callback = null)

No description

static void

assertNothingDispatched()

No description

static Collection

dispatched(string $event, callable|null $callback = null)

No description

static bool

hasDispatched(string $event)

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 protected 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 getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application

$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 EventFake fake(array|string $eventsToFake = [])

Replace the bound instance with a fake.

Parameters

array|string

$eventsToFake

Return Value

EventFake

static EventFake fakeExcept(string[]|string $eventsToAllow)

Replace the bound instance with a fake that fakes all events except the given events.

Parameters

string[]|string

$eventsToAllow

Return Value

EventFake

static mixed fakeFor(callable $callable, array $eventsToFake = [])

Replace the bound instance with a fake during the given callable's execution.

Parameters

callable	$callable
array	$eventsToFake

Return Value

mixed

static mixed fakeExceptFor(callable $callable, array $eventsToAllow = [])

Replace the bound instance with a fake during the given callable's execution.

Parameters

callable	$callable
array	$eventsToAllow

Return Value

mixed

static void listen(Closure|string|array $events, Closure|string|array|null $listener = null)

No description

Parameters

Closure\|string\|array	$events
Closure\|string\|array\|null	$listener

Return Value

void

static bool hasListeners(string $eventName)

No description

Parameters

string

$eventName

Return Value

bool

static bool hasWildcardListeners(string $eventName)

No description

Parameters

string

$eventName

Return Value

bool

static void push(string $event, object|array $payload = [])

No description

Parameters

string	$event
object\|array	$payload

Return Value

void

static void flush(string $event)

No description

Parameters

string

$event

Return Value

void

static void subscribe(object|string $subscriber)

No description

Parameters

object|string

$subscriber

Return Value

void

static array|null until(string|object $event, mixed $payload = [])

No description

Parameters

string\|object	$event
mixed	$payload

Return Value

array|null

static array|null dispatch(string|object $event, mixed $payload = [], bool $halt = false)

No description

Parameters

string\|object	$event
mixed	$payload
bool	$halt

Return Value

array|null

static array getListeners(string $eventName)

No description

Parameters

string

$eventName

Return Value

array

static Closure makeListener(Closure|string|array $listener, bool $wildcard = false)

No description

Parameters

Closure\|string\|array	$listener
bool	$wildcard

Return Value

Closure

static Closure createClassListener(string $listener, bool $wildcard = false)

No description

Parameters

string	$listener
bool	$wildcard

Return Value

Closure

static void forget(string $event)

No description

Parameters

string

$event

Return Value

void

static void forgetPushed()

No description

Return Value

void

static Dispatcher setQueueResolver(callable $resolver)

No description

Parameters

callable

$resolver

Return Value

Dispatcher

static array getRawListeners()

No description

Return Value

array

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

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

No description

Parameters

object	$mixin
bool	$replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string

$name

Return Value

bool

static void flushMacros()

No description

Return Value

void

static EventFake except(array|string $eventsToDispatch)

No description

Parameters

array|string

$eventsToDispatch

Return Value

EventFake

static void assertListening(string $expectedEvent, string|array $expectedListener)

No description

Parameters

string	$expectedEvent
string\|array	$expectedListener

Return Value

void

static void assertDispatched(Closure $event, callable|int|null $callback = null)

No description

Parameters

Closure	$event
callable\|int\|null	$callback

Return Value

void

static void assertDispatchedTimes(string $event, int $times = 1)

No description

Parameters

string	$event
int	$times

Return Value

void

static void assertNotDispatched(Closure $event, callable|null $callback = null)

No description

Parameters

Closure	$event
callable\|null	$callback

Return Value

void

static void assertNothingDispatched()

No description

Return Value

void

static Collection dispatched(string $event, callable|null $callback = null)

No description

Parameters

string	$event
callable\|null	$callback

Return Value

Collection

static bool hasDispatched(string $event)

No description

Parameters

string

$event

Return Value

bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Event.html