class Bus extends Facade

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container|null $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

from  Facade
static protected array<string, int> $coroutineAccessors

Accessors with coroutine-local roots, and their current generation.

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

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
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|null $name = null)

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

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|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 mixed
dispatchChain(mixed $jobs)

Dispatch the given chain of jobs.

static PendingBatch
batch(mixed $jobs)

No description

static void
bulk(iterable $jobs)

No description

static PendingChain
chain(mixed $jobs = 'null')

No description

static mixed
dispatch(mixed $command)

No description

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

No description

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

No description

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

No description

static mixed
dispatchToQueue(mixed $command)

No description

static Batch|null
findBatch(string $batchId)

No description

static mixed
getCommandHandler(mixed $command)

No description

static bool
hasCommandHandler(mixed $command)

No description

static Dispatcher
map(array $map)

No description

static Dispatcher
pipeThrough(array $pipes)

No description

static string|null
resolveConnectionFromQueueRoute(object $queueable, UnitEnum $queue = 'null')

No description

static string|null
resolveQueueFromQueueRoute(object $queueable)

No description

static Dispatcher
static Dispatcher
static void
assertBatchCount(int $count)

No description

static void
assertBatched(array|callable $callback)

No description

static void
assertChained(array $expectedChain)

No description

static void
assertDispatched(Closure|string $command, null|array<string $, mixed>|callable|int $callback = 'null')

No description

static void
assertDispatchedAfterResponse(Closure|string $command, null|array<string $, mixed>|callable|int $callback = 'null')

No description

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

No description

static void
assertDispatchedOnce(Closure|string $command)

No description

static void
assertDispatchedSync(Closure|string $command, null|array<string $, mixed>|callable|int $callback = 'null')

No description

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

No description

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

No description

static void
assertDispatchedWithoutChain(Closure|string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

static void
assertNotDispatched(Closure|string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

static void
assertNotDispatchedAfterResponse(Closure|string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

static void
assertNotDispatchedSync(Closure|string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

static void
assertNothingBatched()

No description

static void
assertNothingChained()

No description

static void
assertNothingDispatched()

No description

static void
assertNothingPlaced()

No description

void
static()

\Hypervel\Support\Collection<int, \Hypervel\Support\Testing\Fakes\PendingBatchFake> batched(callable $callback)

chainedBatch(Closure $callback)

No description

static Collection
dispatched(string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

static Collection
dispatchedAfterResponse(string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

static array
dispatchedBatches()

No description

static Collection
dispatchedSync(string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

static Batch
dispatchFakeBatch(string $name = '\'\'')

No description

static BusFake
except(array|string $jobsToDispatch)

No description

static bool
hasDispatched(string $command)

No description

static bool
hasDispatchedAfterResponse(string $command)

No description

static bool
hasDispatchedSync(string $command)

No description

static Batch
recordPendingBatch(PendingBatch $pendingBatch)

No description

static BusFake
serializeAndRestore(bool $serializeAndRestore = 'true')

No description

Details

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

Run a Closure when the facade has been resolved.

The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 106
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 125
static MockInterface partialMock()

Initiate a partial mock on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 142
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 159
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 176
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 199
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

Hotswap the underlying instance behind the facade.

Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 239
static bool isFake()

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

Return Value

bool

in Facade at line 250
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 266
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 312
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Later facade calls everywhere resolve again; only references already held keep the previous instance.

Parameters

string|null $name

Return Value

void

in Facade at line 330
static void clearResolvedInstances()

Clear all of the resolved instances.

Later facade calls everywhere resolve again; only references already held keep the previous instances.

Return Value

void

in Facade at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 404
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 415
static void setFacadeApplication(Container|null $app)

Set the application instance.

Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException
Throwable

at line 73
static BusFake fake(array|string $jobsToFake = [], BatchRepository|null $batchRepository = null)

Replace the bound instance with a fake.

Swaps the resolved facade instance for the worker lifetime.

Parameters

array|string $jobsToFake
BatchRepository|null $batchRepository

Return Value

BusFake

at line 88
static mixed dispatchChain(mixed $jobs)

Dispatch the given chain of jobs.

Parameters

mixed $jobs

Return Value

mixed

at line 66
static PendingBatch batch(mixed $jobs)

No description

Parameters

mixed $jobs

Return Value

PendingBatch

at line 66
static void bulk(iterable $jobs)

No description

Parameters

iterable $jobs

Return Value

void

at line 66
static PendingChain chain(mixed $jobs = 'null')

No description

Parameters

mixed $jobs

Return Value

PendingChain

at line 66
static mixed dispatch(mixed $command)

No description

Parameters

mixed $command

Return Value

mixed

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

No description

Parameters

mixed $command
mixed $handler

Return Value

void

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

No description

Parameters

mixed $command
mixed $handler

Return Value

mixed

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

No description

Parameters

mixed $command
mixed $handler

Return Value

mixed

at line 66
static mixed dispatchToQueue(mixed $command)

No description

Parameters

mixed $command

Return Value

mixed

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

No description

Parameters

string $batchId

Return Value

Batch|null

at line 66
static mixed getCommandHandler(mixed $command)

No description

Parameters

mixed $command

Return Value

mixed

at line 66
static bool hasCommandHandler(mixed $command)

No description

Parameters

mixed $command

Return Value

bool

at line 66
static Dispatcher map(array $map)

No description

Parameters

array $map

Return Value

Dispatcher

at line 66
static Dispatcher pipeThrough(array $pipes)

No description

Parameters

array $pipes

Return Value

Dispatcher

at line 66
static string|null resolveConnectionFromQueueRoute(object $queueable, UnitEnum $queue = 'null')

No description

Parameters

object $queueable
UnitEnum $queue

Return Value

string|null

at line 66
static string|null resolveQueueFromQueueRoute(object $queueable)

No description

Parameters

object $queueable

Return Value

string|null

at line 66
static Dispatcher withDispatchingAfterResponses()

No description

Return Value

Dispatcher

at line 66
static Dispatcher withoutDispatchingAfterResponses()

No description

Return Value

Dispatcher

at line 66
static void assertBatchCount(int $count)

No description

Parameters

int $count

Return Value

void

at line 66
static void assertBatched(array|callable $callback)

No description

Parameters

array|callable $callback

Return Value

void

at line 66
static void assertChained(array $expectedChain)

No description

Parameters

array $expectedChain

Return Value

void

at line 66
static void assertDispatched(Closure|string $command, null|array<string $, mixed>|callable|int $callback = 'null')

No description

Parameters

Closure|string $command
null|array<string $
mixed>|callable|int $callback

Return Value

void

at line 66
static void assertDispatchedAfterResponse(Closure|string $command, null|array<string $, mixed>|callable|int $callback = 'null')

No description

Parameters

Closure|string $command
null|array<string $
mixed>|callable|int $callback

Return Value

void

at line 66
static void assertDispatchedAfterResponseTimes(Closure|string $command, int $times = '1')

No description

Parameters

Closure|string $command
int $times

Return Value

void

at line 66
static void assertDispatchedOnce(Closure|string $command)

No description

Parameters

Closure|string $command

Return Value

void

at line 66
static void assertDispatchedSync(Closure|string $command, null|array<string $, mixed>|callable|int $callback = 'null')

No description

Parameters

Closure|string $command
null|array<string $
mixed>|callable|int $callback

Return Value

void

at line 66
static void assertDispatchedSyncTimes(Closure|string $command, int $times = '1')

No description

Parameters

Closure|string $command
int $times

Return Value

void

at line 66
static void assertDispatchedTimes(Closure|string $command, int $times = '1')

No description

Parameters

Closure|string $command
int $times

Return Value

void

at line 66
static void assertDispatchedWithoutChain(Closure|string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

Closure|string $command
null|array<string $
mixed>|callable $callback

Return Value

void

at line 66
static void assertNotDispatched(Closure|string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

Closure|string $command
null|array<string $
mixed>|callable $callback

Return Value

void

at line 66
static void assertNotDispatchedAfterResponse(Closure|string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

Closure|string $command
null|array<string $
mixed>|callable $callback

Return Value

void

at line 66
static void assertNotDispatchedSync(Closure|string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

Closure|string $command
null|array<string $
mixed>|callable $callback

Return Value

void

at line 66
static void assertNothingBatched()

No description

Return Value

void

at line 66
static void assertNothingChained()

No description

Return Value

void

at line 66
static void assertNothingDispatched()

No description

Return Value

void

at line 66
static void assertNothingPlaced()

No description

Return Value

void

at line 66
void static()

\Hypervel\Support\Collection<int, \Hypervel\Support\Testing\Fakes\PendingBatchFake> batched(callable $callback)

Return Value

void

at line 66
static ChainedBatchTruthTest chainedBatch(Closure $callback)

No description

Parameters

Closure $callback

Return Value

ChainedBatchTruthTest

at line 66
static Collection dispatched(string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

string $command
null|array<string $
mixed>|callable $callback

Return Value

Collection

at line 66
static Collection dispatchedAfterResponse(string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

string $command
null|array<string $
mixed>|callable $callback

Return Value

Collection

at line 66
static array dispatchedBatches()

No description

Return Value

array

at line 66
static Collection dispatchedSync(string $command, null|array<string $, mixed>|callable $callback = 'null')

No description

Parameters

string $command
null|array<string $
mixed>|callable $callback

Return Value

Collection

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

No description

Parameters

string $name

Return Value

Batch

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

No description

Parameters

array|string $jobsToDispatch

Return Value

BusFake

at line 66
static bool hasDispatched(string $command)

No description

Parameters

string $command

Return Value

bool

at line 66
static bool hasDispatchedAfterResponse(string $command)

No description

Parameters

string $command

Return Value

bool

at line 66
static bool hasDispatchedSync(string $command)

No description

Parameters

string $command

Return Value

bool

at line 66
static Batch recordPendingBatch(PendingBatch $pendingBatch)

No description

Parameters

PendingBatch $pendingBatch

Return Value

Batch

at line 66
static BusFake serializeAndRestore(bool $serializeAndRestore = 'true')

No description

Parameters

bool $serializeAndRestore

Return Value

BusFake