class Queue extends Facade

Properties

static protected $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 
spy()

Convert the facade into a Mockery spy.

from  Facade
static 
partialMock()

Initiate a partial mock on the facade.

from  Facade
static 
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static 
expects()

Initiate a mock expectation on the facade.

from  Facade
static 
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static 
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 
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 
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(mixed $app)

Set the application instance.

from  Facade
static 
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static void
popUsing(string $workerName, callable $callback)

Register a callback to be executed to pick jobs.

static QueueFake
fake(array|string $jobsToFake = [])

Replace the bound instance with a fake.

static QueueFake
fakeExcept(array|string $jobsToAllow)

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

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

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

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

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

static void
before(mixed $callback)

No description

static void
after(mixed $callback)

No description

static void
exceptionOccurred(mixed $callback)

No description

static void
looping(mixed $callback)

No description

static void
failing(mixed $callback)

No description

static void
starting(mixed $callback)

No description

static void
stopping(mixed $callback)

No description

static void
route(array|string $class, UnitEnum|string|null $queue = 'null', UnitEnum|string|null $connection = 'null')

No description

static void
pause(string $connection, string $queue)

No description

static void
pauseFor(string $connection, string $queue, DateTimeInterface|int $ttl)

No description

static void
resume(string $connection, string $queue)

No description

static bool
isPaused(string $connection, string $queue)

No description

static array
getPausedQueues(string $connection, array $queues)

No description

static void
withoutInterruptionPolling()

No description

static bool
connected(UnitEnum|string|null $name = 'null')

No description

static Queue
connection(UnitEnum|string|null $name = 'null')

No description

static void
extend(string $driver, Closure $resolver)

No description

static void
addConnector(string $driver, Closure $resolver)

No description

static string
getDefaultDriver()

No description

static void
setDefaultDriver(UnitEnum|string $name)

No description

static string
getName(string|null $connection = 'null')

No description

static void
purge(string|null $name = 'null')

No description

static Container
getApplication()

No description

static QueueManager
setApplication(Container $app)

No description

static QueueManager
setReleaseCallback(string $driver, Closure $callback)

No description

static Closure|null
getReleaseCallback(string $driver)

No description

static QueueManager
addPoolable(string $driver)

No description

static QueueManager
removePoolable(string $driver)

No description

static array
getPoolables()

No description

static QueueManager
setPoolables(array $poolables)

No description

static string|null
resolveConnectionFromQueueRoute(object $queueable)

No description

static string|null
resolveQueueFromQueueRoute(object $queueable)

No description

static int
size(string|null $queue = 'null')

No description

static int
pendingSize(string|null $queue = 'null')

No description

static int
delayedSize(string|null $queue = 'null')

No description

static int
reservedSize(string|null $queue = 'null')

No description

static int|null
creationTimeOfOldestPendingJob(string|null $queue = 'null')

No description

static mixed
push(object|string $job, mixed $data = '\'\'', string|null $queue = 'null')

No description

static mixed
pushOn(string|null $queue, object|string $job, mixed $data = '\'\'')

No description

static mixed
pushRaw(string $payload, string|null $queue = 'null', array $options = '[]')

No description

static mixed
later(DateTimeInterface|int $delay, object|string $job, mixed $data = '\'\'', string|null $queue = 'null')

No description

static mixed
laterOn(string|null $queue, DateTimeInterface|int $delay, object|string $job, mixed $data = '\'\'')

No description

static mixed
bulk(array $jobs, mixed $data = '\'\'', string|null $queue = 'null')

No description

static Job|null
pop(string|null $queue = 'null')

No description

static string
getConnectionName()

No description

static Queue
setConnectionName(string $name)

No description

static mixed
getJobTries(mixed $job)

No description

static mixed
getJobBackoff(mixed $job)

No description

static mixed
getJobExpiration(mixed $job)

No description

static void
createPayloadUsing(callable|null $callback)

No description

static Queue
setAfterCommitDispatcher(Closure $dispatcher)

No description

static array
getConfig()

No description

static Queue
setConfig(array $config)

No description

static Container
getContainer()

No description

static Queue
setContainer(Container $container)

No description

static void
flushState()

No description

static QueueFake
except(array|string $jobsToBeQueued)

No description

static void
assertPushed(Closure|string $job, callable|int|null $callback = 'null')

No description

static void
assertPushedTimes(string $job, int $times = '1')

No description

static void
assertPushedOnce(string $job)

No description

static void
assertPushedOn(UnitEnum|string|null $queue, Closure|string $job, callable|null $callback = 'null')

No description

static void
assertPushedWithChain(string $job, array $expectedChain = '[]', callable|null $callback = 'null')

No description

static void
assertPushedWithoutChain(string $job, callable|null $callback = 'null')

No description

static void
assertClosurePushed(callable|int|null $callback = 'null')

No description

static void
assertClosureNotPushed(callable|null $callback = 'null')

No description

static void
assertNotPushed(Closure|string $job, callable|null $callback = 'null')

No description

static void
assertCount(int $expectedCount)

No description

static void
assertNothingPushed()

No description

static Collection
pushed(string $job, callable|null $callback = 'null')

No description

void
static()

\Hypervel\Support\Collection<int, mixed> pushedRaw(null|\Closure $callback = 'null')

static Collection
listenersPushed(string $listenerClass, callable|null $callback = 'null')

No description

static bool
hasPushed(string $job)

No description

static Collection
pendingJobs(UnitEnum|string|null $queue = 'null')

No description

static Collection
delayedJobs(UnitEnum|string|null $queue = 'null')

No description

static Collection
reservedJobs(UnitEnum|string|null $queue = 'null')

No description

static Collection
allPendingJobs()

No description

static Collection
allDelayedJobs()

No description

static Collection
allReservedJobs()

No description

static bool
shouldFakeJob(object|string $job)

No description

static void
reserve(object|string $job, UnitEnum|string|null $queue = 'null')

No description

static array
pushedJobs()

No description

static array
rawPushes()

No description

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

No description

static void
releaseUniqueJobLocks()

No description

static void
clearReserved()

No description

static QueueFake
beforePushing(callable $callback)

No description

static QueueFake
afterPushing(callable $callback)

No description

Details

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

Run a Closure when the facade has been resolved.

Boot-only. 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 71
static spy()

Convert the facade into a Mockery spy.

in Facade at line 89
static partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 105
static shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 121
static expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 135
static protected createFreshMockInstance()

Create a fresh mock instance for the given class.

in Facade at line 147
static protected createMock()

Create a fresh mock instance for the given class.

in Facade at line 157
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 184
static swap(mixed $instance)

Hotswap the underlying instance behind the facade.

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

Parameters

mixed $instance

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 207
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 174
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

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

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 257
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 265
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 324
static getFacadeApplication()

Get the application instance behind the facade.

in Facade at line 337
static void setFacadeApplication(mixed $app)

Set the application instance.

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

Parameters

mixed $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Exceptions

RuntimeException

at line 108
static void popUsing(string $workerName, callable $callback)

Register a callback to be executed to pick jobs.

Parameters

string $workerName
callable $callback

Return Value

void

at line 116
static QueueFake fake(array|string $jobsToFake = [])

Replace the bound instance with a fake.

Parameters

array|string $jobsToFake

Return Value

QueueFake

at line 134
static QueueFake fakeExcept(array|string $jobsToAllow)

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

Parameters

array|string $jobsToAllow

Return Value

QueueFake

at line 142
static mixed fakeFor(callable $callable, array $jobsToFake = [])

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

Parameters

callable $callable
array $jobsToFake

Return Value

mixed

at line 158
static mixed fakeExceptFor(callable $callable, array $jobsToAllow = [])

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

Parameters

callable $callable
array $jobsToAllow

Return Value

mixed

at line 103
static void before(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 103
static void after(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 103
static void exceptionOccurred(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 103
static void looping(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 103
static void failing(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 103
static void starting(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 103
static void stopping(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 103
static void route(array|string $class, UnitEnum|string|null $queue = 'null', UnitEnum|string|null $connection = 'null')

No description

Parameters

array|string $class
UnitEnum|string|null $queue
UnitEnum|string|null $connection

Return Value

void

at line 103
static void pause(string $connection, string $queue)

No description

Parameters

string $connection
string $queue

Return Value

void

at line 103
static void pauseFor(string $connection, string $queue, DateTimeInterface|int $ttl)

No description

Parameters

string $connection
string $queue
DateTimeInterface|int $ttl

Return Value

void

at line 103
static void resume(string $connection, string $queue)

No description

Parameters

string $connection
string $queue

Return Value

void

at line 103
static bool isPaused(string $connection, string $queue)

No description

Parameters

string $connection
string $queue

Return Value

bool

at line 103
static array getPausedQueues(string $connection, array $queues)

No description

Parameters

string $connection
array $queues

Return Value

array

at line 103
static void withoutInterruptionPolling()

No description

Return Value

void

at line 103
static bool connected(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

bool

at line 103
static Queue connection(UnitEnum|string|null $name = 'null')

No description

Parameters

UnitEnum|string|null $name

Return Value

Queue

at line 103
static void extend(string $driver, Closure $resolver)

No description

Parameters

string $driver
Closure $resolver

Return Value

void

at line 103
static void addConnector(string $driver, Closure $resolver)

No description

Parameters

string $driver
Closure $resolver

Return Value

void

at line 103
static string getDefaultDriver()

No description

Return Value

string

at line 103
static void setDefaultDriver(UnitEnum|string $name)

No description

Parameters

UnitEnum|string $name

Return Value

void

at line 103
static string getName(string|null $connection = 'null')

No description

Parameters

string|null $connection

Return Value

string

at line 103
static void purge(string|null $name = 'null')

No description

Parameters

string|null $name

Return Value

void

at line 103
static Container getApplication()

No description

Return Value

Container

at line 103
static QueueManager setApplication(Container $app)

No description

Parameters

Container $app

Return Value

QueueManager

at line 103
static QueueManager setReleaseCallback(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

QueueManager

at line 103
static Closure|null getReleaseCallback(string $driver)

No description

Parameters

string $driver

Return Value

Closure|null

at line 103
static QueueManager addPoolable(string $driver)

No description

Parameters

string $driver

Return Value

QueueManager

at line 103
static QueueManager removePoolable(string $driver)

No description

Parameters

string $driver

Return Value

QueueManager

at line 103
static array getPoolables()

No description

Return Value

array

at line 103
static QueueManager setPoolables(array $poolables)

No description

Parameters

array $poolables

Return Value

QueueManager

at line 103
static string|null resolveConnectionFromQueueRoute(object $queueable)

No description

Parameters

object $queueable

Return Value

string|null

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

No description

Parameters

object $queueable

Return Value

string|null

at line 103
static int size(string|null $queue = 'null')

No description

Parameters

string|null $queue

Return Value

int

at line 103
static int pendingSize(string|null $queue = 'null')

No description

Parameters

string|null $queue

Return Value

int

at line 103
static int delayedSize(string|null $queue = 'null')

No description

Parameters

string|null $queue

Return Value

int

at line 103
static int reservedSize(string|null $queue = 'null')

No description

Parameters

string|null $queue

Return Value

int

at line 103
static int|null creationTimeOfOldestPendingJob(string|null $queue = 'null')

No description

Parameters

string|null $queue

Return Value

int|null

at line 103
static mixed push(object|string $job, mixed $data = '\'\'', string|null $queue = 'null')

No description

Parameters

object|string $job
mixed $data
string|null $queue

Return Value

mixed

at line 103
static mixed pushOn(string|null $queue, object|string $job, mixed $data = '\'\'')

No description

Parameters

string|null $queue
object|string $job
mixed $data

Return Value

mixed

at line 103
static mixed pushRaw(string $payload, string|null $queue = 'null', array $options = '[]')

No description

Parameters

string $payload
string|null $queue
array $options

Return Value

mixed

at line 103
static mixed later(DateTimeInterface|int $delay, object|string $job, mixed $data = '\'\'', string|null $queue = 'null')

No description

Parameters

DateTimeInterface|int $delay
object|string $job
mixed $data
string|null $queue

Return Value

mixed

at line 103
static mixed laterOn(string|null $queue, DateTimeInterface|int $delay, object|string $job, mixed $data = '\'\'')

No description

Parameters

string|null $queue
DateTimeInterface|int $delay
object|string $job
mixed $data

Return Value

mixed

at line 103
static mixed bulk(array $jobs, mixed $data = '\'\'', string|null $queue = 'null')

No description

Parameters

array $jobs
mixed $data
string|null $queue

Return Value

mixed

at line 103
static Job|null pop(string|null $queue = 'null')

No description

Parameters

string|null $queue

Return Value

Job|null

at line 103
static string getConnectionName()

No description

Return Value

string

at line 103
static Queue setConnectionName(string $name)

No description

Parameters

string $name

Return Value

Queue

at line 103
static mixed getJobTries(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

at line 103
static mixed getJobBackoff(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

at line 103
static mixed getJobExpiration(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

at line 103
static void createPayloadUsing(callable|null $callback)

No description

Parameters

callable|null $callback

Return Value

void

at line 103
static Queue setAfterCommitDispatcher(Closure $dispatcher)

No description

Parameters

Closure $dispatcher

Return Value

Queue

at line 103
static array getConfig()

No description

Return Value

array

at line 103
static Queue setConfig(array $config)

No description

Parameters

array $config

Return Value

Queue

at line 103
static Container getContainer()

No description

Return Value

Container

at line 103
static Queue setContainer(Container $container)

No description

Parameters

Container $container

Return Value

Queue

at line 103
static void flushState()

No description

Return Value

void

at line 103
static QueueFake except(array|string $jobsToBeQueued)

No description

Parameters

array|string $jobsToBeQueued

Return Value

QueueFake

at line 103
static void assertPushed(Closure|string $job, callable|int|null $callback = 'null')

No description

Parameters

Closure|string $job
callable|int|null $callback

Return Value

void

at line 103
static void assertPushedTimes(string $job, int $times = '1')

No description

Parameters

string $job
int $times

Return Value

void

at line 103
static void assertPushedOnce(string $job)

No description

Parameters

string $job

Return Value

void

at line 103
static void assertPushedOn(UnitEnum|string|null $queue, Closure|string $job, callable|null $callback = 'null')

No description

Parameters

UnitEnum|string|null $queue
Closure|string $job
callable|null $callback

Return Value

void

at line 103
static void assertPushedWithChain(string $job, array $expectedChain = '[]', callable|null $callback = 'null')

No description

Parameters

string $job
array $expectedChain
callable|null $callback

Return Value

void

at line 103
static void assertPushedWithoutChain(string $job, callable|null $callback = 'null')

No description

Parameters

string $job
callable|null $callback

Return Value

void

at line 103
static void assertClosurePushed(callable|int|null $callback = 'null')

No description

Parameters

callable|int|null $callback

Return Value

void

at line 103
static void assertClosureNotPushed(callable|null $callback = 'null')

No description

Parameters

callable|null $callback

Return Value

void

at line 103
static void assertNotPushed(Closure|string $job, callable|null $callback = 'null')

No description

Parameters

Closure|string $job
callable|null $callback

Return Value

void

at line 103
static void assertCount(int $expectedCount)

No description

Parameters

int $expectedCount

Return Value

void

at line 103
static void assertNothingPushed()

No description

Return Value

void

at line 103
static Collection pushed(string $job, callable|null $callback = 'null')

No description

Parameters

string $job
callable|null $callback

Return Value

Collection

at line 103
void static()

\Hypervel\Support\Collection<int, mixed> pushedRaw(null|\Closure $callback = 'null')

Return Value

void

at line 103
static Collection listenersPushed(string $listenerClass, callable|null $callback = 'null')

No description

Parameters

string $listenerClass
callable|null $callback

Return Value

Collection

at line 103
static bool hasPushed(string $job)

No description

Parameters

string $job

Return Value

bool

at line 103
static Collection pendingJobs(UnitEnum|string|null $queue = 'null')

No description

Parameters

UnitEnum|string|null $queue

Return Value

Collection

at line 103
static Collection delayedJobs(UnitEnum|string|null $queue = 'null')

No description

Parameters

UnitEnum|string|null $queue

Return Value

Collection

at line 103
static Collection reservedJobs(UnitEnum|string|null $queue = 'null')

No description

Parameters

UnitEnum|string|null $queue

Return Value

Collection

at line 103
static Collection allPendingJobs()

No description

Return Value

Collection

at line 103
static Collection allDelayedJobs()

No description

Return Value

Collection

at line 103
static Collection allReservedJobs()

No description

Return Value

Collection

at line 103
static bool shouldFakeJob(object|string $job)

No description

Parameters

object|string $job

Return Value

bool

at line 103
static void reserve(object|string $job, UnitEnum|string|null $queue = 'null')

No description

Parameters

object|string $job
UnitEnum|string|null $queue

Return Value

void

at line 103
static array pushedJobs()

No description

Return Value

array

at line 103
static array rawPushes()

No description

Return Value

array

at line 103
static QueueFake serializeAndRestore(bool $serializeAndRestore = 'true')

No description

Parameters

bool $serializeAndRestore

Return Value

QueueFake

at line 103
static void releaseUniqueJobLocks()

No description

Return Value

void

at line 103
static void clearReserved()

No description

Return Value

void

at line 103
static QueueFake beforePushing(callable $callback)

No description

Parameters

callable $callback

Return Value

QueueFake

at line 103
static QueueFake afterPushing(callable $callback)

No description

Parameters

callable $callback

Return Value

QueueFake