1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. Event

Event

class Event 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 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
listen(QueuedClosure|callable|array|string $events, QueuedClosure|callable|array|string|null $listener = null)

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 mixed
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 Dispatcher
setTransactionManagerResolver(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

static array
dispatchedEvents()

No description

Details

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

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 65
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 81
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 97
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 113
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 129
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 143
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 155
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 195
static bool isFake()

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

Return Value

bool

in Facade at line 208
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 126
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 252
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 262
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 272
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 328
static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

in Facade at line 339
static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 50
static EventFake fake(array|string $eventsToFake = [])

Replace the bound instance with a fake.

Parameters

array|string $eventsToFake

Return Value

EventFake

at line 70
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

at line 86
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

at line 107
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

at line 42
static void listen(QueuedClosure|callable|array|string $events, QueuedClosure|callable|array|string|null $listener = null)

No description

Parameters

QueuedClosure|callable|array|string $events
QueuedClosure|callable|array|string|null $listener

Return Value

void

at line 42
static bool hasListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

bool

at line 42
static bool hasWildcardListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

bool

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

No description

Parameters

string $event
object|array $payload

Return Value

void

at line 42
static void flush(string $event)

No description

Parameters

string $event

Return Value

void

at line 42
static void subscribe(object|string $subscriber)

No description

Parameters

object|string $subscriber

Return Value

void

at line 42
static mixed until(string|object $event, mixed $payload = [])

No description

Parameters

string|object $event
mixed $payload

Return Value

mixed

at line 42
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

at line 42
static array getListeners(string $eventName)

No description

Parameters

string $eventName

Return Value

array

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

No description

Parameters

Closure|string|array $listener
bool $wildcard

Return Value

Closure

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

No description

Parameters

string $listener
bool $wildcard

Return Value

Closure

at line 42
static void forget(string $event)

No description

Parameters

string $event

Return Value

void

at line 42
static void forgetPushed()

No description

Return Value

void

at line 42
static Dispatcher setQueueResolver(callable $resolver)

No description

Parameters

callable $resolver

Return Value

Dispatcher

at line 42
static Dispatcher setTransactionManagerResolver(callable $resolver)

No description

Parameters

callable $resolver

Return Value

Dispatcher

at line 42
static array getRawListeners()

No description

Return Value

array

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

No description

Parameters

string $name
object|callable $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 42
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 42
static void flushMacros()

No description

Return Value

void

at line 42
static EventFake except(array|string $eventsToDispatch)

No description

Parameters

array|string $eventsToDispatch

Return Value

EventFake

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

No description

Parameters

string $expectedEvent
string|array $expectedListener

Return Value

void

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

No description

Parameters

Closure $event
callable|int|null $callback

Return Value

void

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

No description

Parameters

string $event
int $times

Return Value

void

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

No description

Parameters

Closure $event
callable|null $callback

Return Value

void

at line 42
static void assertNothingDispatched()

No description

Return Value

void

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

No description

Parameters

string $event
callable|null $callback

Return Value

Collection

at line 42
static bool hasDispatched(string $event)

No description

Parameters

string $event

Return Value

bool

at line 42
static array dispatchedEvents()

No description

Return Value

array