Bus

class Bus 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 BusFake

fake(array|string $jobsToFake = [], BatchRepository $batchRepository = null)

Replace the bound instance with a fake.

static PendingDispatch

dispatchChain(array|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|array|mixed $jobs)

No description

static PendingChain

chain(Collection|array $jobs)

No description

static bool

hasCommandHandler(mixed $command)

No description

static bool|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 BusFake

except(array|string $jobsToDispatch)

No description

static void

assertDispatched(Closure $command, callable|int|null $callback = 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

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

No description

static void

assertBatched(callable $callback)

No description

static void

assertBatchCount(int $count)

No description

static void

assertNothingBatched()

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

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

Replace the bound instance with a fake.

Parameters

array\|string	$jobsToFake
BatchRepository	$batchRepository

Return Value

BusFake

static PendingDispatch dispatchChain(array|mixed $jobs)

Dispatch the given chain of jobs.

Parameters

array|mixed

$jobs

Return Value

PendingDispatch

static mixed dispatch(mixed $command)

No description

Parameters

mixed

$command

Return Value

mixed

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

No description

Parameters

mixed	$command
mixed	$handler

Return Value

mixed

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

No description

Parameters

mixed	$command
mixed	$handler

Return Value

mixed

static Batch|null findBatch(string $batchId)

No description

Parameters

string

$batchId

Return Value

Batch|null

static PendingBatch batch(Collection|array|mixed $jobs)

No description

Parameters

Collection|array|mixed

$jobs

Return Value

PendingBatch

static PendingChain chain(Collection|array $jobs)

No description

Parameters

Collection|array

$jobs

Return Value

PendingChain

static bool hasCommandHandler(mixed $command)

No description

Parameters

mixed

$command

Return Value

bool

static bool|mixed getCommandHandler(mixed $command)

No description

Parameters

mixed

$command

Return Value

bool|mixed

static mixed dispatchToQueue(mixed $command)

No description

Parameters

mixed

$command

Return Value

mixed

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

No description

Parameters

mixed	$command
mixed	$handler

Return Value

void

static Dispatcher pipeThrough(array $pipes)

No description

Parameters

array

$pipes

Return Value

Dispatcher

static Dispatcher map(array $map)

No description

Parameters

array

$map

Return Value

Dispatcher

static BusFake except(array|string $jobsToDispatch)

No description

Parameters

array|string

$jobsToDispatch

Return Value

BusFake

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

No description

Parameters

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

Return Value

void

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

No description

Parameters

Closure	$command
int	$times

Return Value

void

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

No description

Parameters

Closure	$command
callable\|null	$callback

Return Value

void

static void assertNothingDispatched()

No description

Return Value

void

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

No description

Parameters

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

Return Value

void

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

No description

Parameters

Closure	$command
int	$times

Return Value

void

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

No description

Parameters

Closure	$command
callable\|null	$callback

Return Value

void

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

No description

Parameters

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

Return Value

void

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

No description

Parameters

Closure	$command
int	$times

Return Value

void

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

No description

Parameters

Closure	$command
callable\|null	$callback

Return Value

void

static void assertChained(array $expectedChain)

No description

Parameters

array

$expectedChain

Return Value

void

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

No description

Parameters

Closure	$command
callable\|null	$callback

Return Value

void

static void assertBatched(callable $callback)

No description

Parameters

callable

$callback

Return Value

void

static void assertBatchCount(int $count)

No description

Parameters

int

$count

Return Value

void

static void assertNothingBatched()

No description

Return Value

void

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

No description

Parameters

string	$command
callable\|null	$callback

Return Value

Collection

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

No description

Parameters

string	$command
callable\|null	$callback

Return Value

Collection

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

No description

Parameters

string	$command
callable\|null	$callback

Return Value

Collection

static Collection batched(callable $callback)

No description

Parameters

callable

$callback

Return Value

Collection

static bool hasDispatched(string $command)

No description

Parameters

string

$command

Return Value

bool

static bool hasDispatchedSync(string $command)

No description

Parameters

string

$command

Return Value

bool

static bool hasDispatchedAfterResponse(string $command)

No description

Parameters

string

$command

Return Value

bool

static Batch dispatchFakeBatch(string $name = '')

No description

Parameters

string

$name

Return Value

Batch

static Batch recordPendingBatch(PendingBatch $pendingBatch)

No description

Parameters

PendingBatch

$pendingBatch

Return Value

Batch

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