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

Bus

class Bus 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 BusFake
fake(array|string $jobsToFake = [], BatchRepository|null $batchRepository = null)

Replace the bound instance with a fake.

static PendingDispatch
dispatchChain(mixed $jobs)

Dispatch the given chain of jobs.

static mixed
dispatch(mixed $command)

No description

static mixed
dispatchSync(mixed $command, mixed $handler = null)

No description

static mixed
dispatchNow(mixed $command, mixed $handler = null)

No description

static Batch|null
findBatch(string $batchId)

No description

static PendingBatch
batch(Collection|mixed $jobs)

No description

static PendingChain
chain(Collection|array|null $jobs = null)

No description

static bool
hasCommandHandler(mixed $command)

No description

static mixed
getCommandHandler(mixed $command)

No description

static mixed
dispatchToQueue(mixed $command)

No description

static void
dispatchAfterResponse(mixed $command, mixed $handler = null)

No description

static Dispatcher
pipeThrough(array $pipes)

No description

static Dispatcher
map(array $map)

No description

static Dispatcher
withDispatchingAfterResponses()

No description

static Dispatcher
withoutDispatchingAfterResponses()

No description

static BusFake
except(array|string $jobsToDispatch)

No description

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

No description

static void
assertDispatchedOnce(Closure $command, int $times = null)

No description

static void
assertDispatchedTimes(Closure $command, int $times = 1)

No description

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

No description

static void
assertNothingDispatched()

No description

static void
assertDispatchedSync(Closure $command, callable|int|null $callback = null)

No description

static void
assertDispatchedSyncTimes(Closure $command, int $times = 1)

No description

static void
assertNotDispatchedSync(Closure $command, callable|null $callback = null)

No description

static void
assertDispatchedAfterResponse(Closure $command, callable|int|null $callback = null)

No description

static void
assertDispatchedAfterResponseTimes(Closure $command, int $times = 1)

No description

static void
assertNotDispatchedAfterResponse(Closure $command, callable|null $callback = null)

No description

static void
assertChained(array $expectedChain)

No description

static void
assertNothingChained()

No description

static void
assertDispatchedWithoutChain(Closure $command, callable|null $callback = null)

No description

static ChainedBatchTruthTest
chainedBatch(Closure $callback)

No description

static void
assertBatched(callable $callback)

No description

static void
assertBatchCount(int $count)

No description

static void
assertNothingBatched()

No description

static void
assertNothingPlaced()

No description

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

No description

static Collection
dispatchedSync(string $command, callable|null $callback = null)

No description

static Collection
dispatchedAfterResponse(string $command, callable|null $callback = null)

No description

static Collection
batched(callable $callback)

No description

static bool
hasDispatched(string $command)

No description

static bool
hasDispatchedSync(string $command)

No description

static bool
hasDispatchedAfterResponse(string $command)

No description

static Batch
dispatchFakeBatch(string $name = '')

No description

static Batch
recordPendingBatch(PendingBatch $pendingBatch)

No description

static BusFake
serializeAndRestore(bool $serializeAndRestore = true)

No description

static array
dispatchedBatches()

No description

Details

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

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 66
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 82
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 98
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 114
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 130
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 144
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 156
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 196
static bool isFake()

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

Return Value

bool

in Facade at line 209
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 99
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

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

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 263
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 273
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

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

Get the application instance behind the facade.

Return Value

Application|null

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

Set the application instance.

Parameters

Application|null $app

Return Value

void

in Facade at line 355
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 69
static BusFake fake(array|string $jobsToFake = [], BatchRepository|null $batchRepository = null)

Replace the bound instance with a fake.

Parameters

array|string $jobsToFake
BatchRepository|null $batchRepository

Return Value

BusFake

at line 86
static PendingDispatch dispatchChain(mixed $jobs)

Dispatch the given chain of jobs.

Parameters

mixed $jobs

Return Value

PendingDispatch

at line 60
static mixed dispatch(mixed $command)

No description

Parameters

mixed $command

Return Value

mixed

at line 60
static mixed dispatchSync(mixed $command, mixed $handler = null)

No description

Parameters

mixed $command
mixed $handler

Return Value

mixed

at line 60
static mixed dispatchNow(mixed $command, mixed $handler = null)

No description

Parameters

mixed $command
mixed $handler

Return Value

mixed

at line 60
static Batch|null findBatch(string $batchId)

No description

Parameters

string $batchId

Return Value

Batch|null

at line 60
static PendingBatch batch(Collection|mixed $jobs)

No description

Parameters

Collection|mixed $jobs

Return Value

PendingBatch

at line 60
static PendingChain chain(Collection|array|null $jobs = null)

No description

Parameters

Collection|array|null $jobs

Return Value

PendingChain

at line 60
static bool hasCommandHandler(mixed $command)

No description

Parameters

mixed $command

Return Value

bool

at line 60
static mixed getCommandHandler(mixed $command)

No description

Parameters

mixed $command

Return Value

mixed

at line 60
static mixed dispatchToQueue(mixed $command)

No description

Parameters

mixed $command

Return Value

mixed

at line 60
static void dispatchAfterResponse(mixed $command, mixed $handler = null)

No description

Parameters

mixed $command
mixed $handler

Return Value

void

at line 60
static Dispatcher pipeThrough(array $pipes)

No description

Parameters

array $pipes

Return Value

Dispatcher

at line 60
static Dispatcher map(array $map)

No description

Parameters

array $map

Return Value

Dispatcher

at line 60
static Dispatcher withDispatchingAfterResponses()

No description

Return Value

Dispatcher

at line 60
static Dispatcher withoutDispatchingAfterResponses()

No description

Return Value

Dispatcher

at line 60
static BusFake except(array|string $jobsToDispatch)

No description

Parameters

array|string $jobsToDispatch

Return Value

BusFake

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

No description

Parameters

Closure $command
callable|int|null $callback

Return Value

void

at line 60
static void assertDispatchedOnce(Closure $command, int $times = null)

No description

Parameters

Closure $command
int $times

Return Value

void

at line 60
static void assertDispatchedTimes(Closure $command, int $times = 1)

No description

Parameters

Closure $command
int $times

Return Value

void

at line 60
static void assertNotDispatched(Closure $command, callable|null $callback = null)

No description

Parameters

Closure $command
callable|null $callback

Return Value

void

at line 60
static void assertNothingDispatched()

No description

Return Value

void

at line 60
static void assertDispatchedSync(Closure $command, callable|int|null $callback = null)

No description

Parameters

Closure $command
callable|int|null $callback

Return Value

void

at line 60
static void assertDispatchedSyncTimes(Closure $command, int $times = 1)

No description

Parameters

Closure $command
int $times

Return Value

void

at line 60
static void assertNotDispatchedSync(Closure $command, callable|null $callback = null)

No description

Parameters

Closure $command
callable|null $callback

Return Value

void

at line 60
static void assertDispatchedAfterResponse(Closure $command, callable|int|null $callback = null)

No description

Parameters

Closure $command
callable|int|null $callback

Return Value

void

at line 60
static void assertDispatchedAfterResponseTimes(Closure $command, int $times = 1)

No description

Parameters

Closure $command
int $times

Return Value

void

at line 60
static void assertNotDispatchedAfterResponse(Closure $command, callable|null $callback = null)

No description

Parameters

Closure $command
callable|null $callback

Return Value

void

at line 60
static void assertChained(array $expectedChain)

No description

Parameters

array $expectedChain

Return Value

void

at line 60
static void assertNothingChained()

No description

Return Value

void

at line 60
static void assertDispatchedWithoutChain(Closure $command, callable|null $callback = null)

No description

Parameters

Closure $command
callable|null $callback

Return Value

void

at line 60
static ChainedBatchTruthTest chainedBatch(Closure $callback)

No description

Parameters

Closure $callback

Return Value

ChainedBatchTruthTest

at line 60
static void assertBatched(callable $callback)

No description

Parameters

callable $callback

Return Value

void

at line 60
static void assertBatchCount(int $count)

No description

Parameters

int $count

Return Value

void

at line 60
static void assertNothingBatched()

No description

Return Value

void

at line 60
static void assertNothingPlaced()

No description

Return Value

void

at line 60
static Collection dispatched(string $command, callable|null $callback = null)

No description

Parameters

string $command
callable|null $callback

Return Value

Collection

at line 60
static Collection dispatchedSync(string $command, callable|null $callback = null)

No description

Parameters

string $command
callable|null $callback

Return Value

Collection

at line 60
static Collection dispatchedAfterResponse(string $command, callable|null $callback = null)

No description

Parameters

string $command
callable|null $callback

Return Value

Collection

at line 60
static Collection batched(callable $callback)

No description

Parameters

callable $callback

Return Value

Collection

at line 60
static bool hasDispatched(string $command)

No description

Parameters

string $command

Return Value

bool

at line 60
static bool hasDispatchedSync(string $command)

No description

Parameters

string $command

Return Value

bool

at line 60
static bool hasDispatchedAfterResponse(string $command)

No description

Parameters

string $command

Return Value

bool

at line 60
static Batch dispatchFakeBatch(string $name = '')

No description

Parameters

string $name

Return Value

Batch

at line 60
static Batch recordPendingBatch(PendingBatch $pendingBatch)

No description

Parameters

PendingBatch $pendingBatch

Return Value

Batch

at line 60
static BusFake serializeAndRestore(bool $serializeAndRestore = true)

No description

Parameters

bool $serializeAndRestore

Return Value

BusFake

at line 60
static array dispatchedBatches()

No description

Return Value

array