class Queue extends Facade

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 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 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
addConnector(string $driver, Closure $resolver)

No description

static QueueManager
addPoolableDriver(string $driver)

No description

static void
after(mixed $callback)

No description

static void
before(mixed $callback)

No description

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

No description

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

No description

static void
createPayloadUsing(callable|null $callback)

No description

static void
exceptionOccurred(mixed $callback)

No description

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

No description

static void
failing(mixed $callback)

No description

static void
forward(array<array-key $, UnitEnum $queue, UnitEnum|string|null $to = 'null', UnitEnum|string|null $connection = 'null')

No description

static Container
getApplication()

No description

static string
getDefaultDriver()

No description

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

No description

static array
getPausedQueues(array $queues, string|null $connection = 'null')

No description

static array
getPoolableDrivers()

No description

static Closure|null
getReleaseCallback(string $driver)

No description

static bool
isPaused(string $queue, string|null $connection = 'null')

No description

static void
looping(mixed $callback)

No description

static void
pause(UnitEnum|string $queue, UnitEnum|string|null $connection = 'null')

No description

static void
pauseAll()

No description

static void
pauseFor(UnitEnum|string $queue, DateTimeInterface|int $ttl, UnitEnum|string|null $connection = 'null')

No description

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

No description

static QueueManager
removePoolableDriver(string $driver)

No description

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

No description

static string|null
resolveQueueFromQueueRoute(object $queueable)

No description

static void
resume(UnitEnum|string $queue, UnitEnum|string|null $connection = 'null')

No description

static void
resumeAll()

No description

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

No description

static QueueManager
setApplication(Container $app)

No description

static void
setDefaultDriver(UnitEnum|string $name)

No description

static QueueManager
setPoolableDrivers(array $poolableDrivers)

No description

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

No description

static void
starting(mixed $callback)

No description

static void
stopping(mixed $callback)

No description

static void
withoutInterruptionPolling()

No description

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

No description

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

No description

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

No description

static string
getConnectionName()

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static Queue
setConnectionName(string $name)

No description

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

No description

static void
flushState()

No description

static array
getConfig()

No description

static Container
getContainer()

No description

static mixed
getJobBackoff(mixed $job)

No description

static mixed
getJobExpiration(mixed $job)

No description

static mixed
getJobTries(mixed $job)

No description

static Queue
setAfterCommitDispatcher(Closure $dispatcher)

No description

static Queue
setConfig(array $config)

No description

static Queue
setContainer(Container $container)

No description

static QueueFake
afterPushing(callable $callback)

No description

void
static()

\Hypervel\Support\Collection<int, \Hypervel\Queue\Jobs\InspectedJob> reservedJobs(\UnitEnum|string|null $queue = 'null')

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

No description

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

No description

static void
assertCount(int $expectedCount)

No description

static void
assertNothingPushed()

No description

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

No description

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

No description

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

No description

static void
assertPushedOnce(string $job)

No description

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

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 QueueFake
beforePushing(callable $callback)

No description

static void
clearReserved()

No description

static QueueFake
except(array|string $jobsToBeQueued)

No description

static bool
hasPushed(string $job)

No description

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

No description

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

No description

static array
pushedJobs()

No description

static void
array()

<int, mixed> rawPushes()

static void
releaseUniqueJobLocks()

No description

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

No description

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

No description

static bool
shouldFakeJob(object|string $job)

No description

static int
totalDelayedSize()

No description

static int
totalPendingSize()

No description

static int
totalReservedSize()

No description

static int
totalSize()

No description

Details

in Facade at line 61
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 81
static MockInterface|null spy()

Convert the facade into a Mockery spy.

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

Return Value

MockInterface|null

in Facade at line 99
static MockInterface partialMock()

Initiate a partial mock on the facade.

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

Return Value

MockInterface

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

Initiate a mock expectation on the facade.

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

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

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

Initiate a mock expectation on the facade.

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

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 145
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 157
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 167
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 194
static void 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

Return Value

void

in Facade at line 206
static bool isFake()

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

Return Value

bool

in Facade at line 217
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 184
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 256
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 267
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 275
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

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

Get the application instance behind the facade.

Return Value

Container|null

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

Set the application instance.

Boot or tests only. 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 356
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 116
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 124
static QueueFake fake(array|string $jobsToFake = [])

Replace the bound instance with a fake.

Parameters

array|string $jobsToFake

Return Value

QueueFake

at line 144
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 152
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 168
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 111
static void addConnector(string $driver, Closure $resolver)

No description

Parameters

string $driver
Closure $resolver

Return Value

void

at line 111
static QueueManager addPoolableDriver(string $driver)

No description

Parameters

string $driver

Return Value

QueueManager

at line 111
static void after(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 111
static void before(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

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

No description

Parameters

UnitEnum|string|null $name

Return Value

bool

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

No description

Parameters

UnitEnum|string|null $name

Return Value

Queue

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

No description

Parameters

callable|null $callback

Return Value

void

at line 111
static void exceptionOccurred(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

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

No description

Parameters

string $driver
Closure $resolver

Return Value

void

at line 111
static void failing(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 111
static void forward(array<array-key $, UnitEnum $queue, UnitEnum|string|null $to = 'null', UnitEnum|string|null $connection = 'null')

No description

Parameters

array<array-key $
UnitEnum $queue
UnitEnum|string|null $to
UnitEnum|string|null $connection

Return Value

void

at line 111
static Container getApplication()

No description

Return Value

Container

at line 111
static string getDefaultDriver()

No description

Return Value

string

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

No description

Parameters

string|null $connection

Return Value

string

at line 111
static array getPausedQueues(array $queues, string|null $connection = 'null')

No description

Parameters

array $queues
string|null $connection

Return Value

array

at line 111
static array getPoolableDrivers()

No description

Return Value

array

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

No description

Parameters

string $driver

Return Value

Closure|null

at line 111
static bool isPaused(string $queue, string|null $connection = 'null')

No description

Parameters

string $queue
string|null $connection

Return Value

bool

at line 111
static void looping(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 111
static void pause(UnitEnum|string $queue, UnitEnum|string|null $connection = 'null')

No description

Parameters

UnitEnum|string $queue
UnitEnum|string|null $connection

Return Value

void

at line 111
static void pauseAll()

No description

Return Value

void

at line 111
static void pauseFor(UnitEnum|string $queue, DateTimeInterface|int $ttl, UnitEnum|string|null $connection = 'null')

No description

Parameters

UnitEnum|string $queue
DateTimeInterface|int $ttl
UnitEnum|string|null $connection

Return Value

void

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

No description

Parameters

string|null $name

Return Value

void

at line 111
static QueueManager removePoolableDriver(string $driver)

No description

Parameters

string $driver

Return Value

QueueManager

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

No description

Parameters

object $queueable
UnitEnum $queue

Return Value

string|null

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

No description

Parameters

object $queueable

Return Value

string|null

at line 111
static void resume(UnitEnum|string $queue, UnitEnum|string|null $connection = 'null')

No description

Parameters

UnitEnum|string $queue
UnitEnum|string|null $connection

Return Value

void

at line 111
static void resumeAll()

No description

Return Value

void

at line 111
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 111
static QueueManager setApplication(Container $app)

No description

Parameters

Container $app

Return Value

QueueManager

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

No description

Parameters

UnitEnum|string $name

Return Value

void

at line 111
static QueueManager setPoolableDrivers(array $poolableDrivers)

No description

Parameters

array $poolableDrivers

Return Value

QueueManager

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

No description

Parameters

string $driver
Closure $callback

Return Value

QueueManager

at line 111
static void starting(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 111
static void stopping(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 111
static void withoutInterruptionPolling()

No description

Return Value

void

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

No description

Parameters

array $jobs
mixed $data
UnitEnum|string|null $queue

Return Value

mixed

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

No description

Parameters

UnitEnum|string|null $queue

Return Value

int|null

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

No description

Parameters

UnitEnum|string|null $queue

Return Value

int

at line 111
static string getConnectionName()

No description

Return Value

string

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

UnitEnum|string|null $queue

Return Value

int

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

No description

Parameters

UnitEnum|string|null $queue

Return Value

Job|null

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

string $payload
UnitEnum|string|null $queue
array $options

Return Value

mixed

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

No description

Parameters

UnitEnum|string|null $queue

Return Value

int

at line 111
static Queue setConnectionName(string $name)

No description

Parameters

string $name

Return Value

Queue

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

No description

Parameters

UnitEnum|string|null $queue

Return Value

int

at line 111
static void flushState()

No description

Return Value

void

at line 111
static array getConfig()

No description

Return Value

array

at line 111
static Container getContainer()

No description

Return Value

Container

at line 111
static mixed getJobBackoff(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

at line 111
static mixed getJobExpiration(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

at line 111
static mixed getJobTries(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

at line 111
static Queue setAfterCommitDispatcher(Closure $dispatcher)

No description

Parameters

Closure $dispatcher

Return Value

Queue

at line 111
static Queue setConfig(array $config)

No description

Parameters

array $config

Return Value

Queue

at line 111
static Queue setContainer(Container $container)

No description

Parameters

Container $container

Return Value

Queue

at line 111
static QueueFake afterPushing(callable $callback)

No description

Parameters

callable $callback

Return Value

QueueFake

at line 111
void static()

\Hypervel\Support\Collection<int, \Hypervel\Queue\Jobs\InspectedJob> reservedJobs(\UnitEnum|string|null $queue = 'null')

Return Value

void

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

No description

Parameters

callable|null $callback

Return Value

void

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

No description

Parameters

callable|int|null $callback

Return Value

void

at line 111
static void assertCount(int $expectedCount)

No description

Parameters

int $expectedCount

Return Value

void

at line 111
static void assertNothingPushed()

No description

Return Value

void

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

No description

Parameters

Closure|string $job
callable|null $callback

Return Value

void

at line 111
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 111
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 111
static void assertPushedOnce(string $job)

No description

Parameters

string $job

Return Value

void

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

No description

Parameters

string $job
int $times

Return Value

void

at line 111
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 111
static void assertPushedWithoutChain(string $job, callable|null $callback = 'null')

No description

Parameters

string $job
callable|null $callback

Return Value

void

at line 111
static QueueFake beforePushing(callable $callback)

No description

Parameters

callable $callback

Return Value

QueueFake

at line 111
static void clearReserved()

No description

Return Value

void

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

No description

Parameters

array|string $jobsToBeQueued

Return Value

QueueFake

at line 111
static bool hasPushed(string $job)

No description

Parameters

string $job

Return Value

bool

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

No description

Parameters

string $listenerClass
callable|null $callback

Return Value

Collection

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

No description

Parameters

string $job
callable|null $callback

Return Value

Collection

at line 111
static array pushedJobs()

No description

Return Value

array

at line 111
static void array()

<int, mixed> rawPushes()

Return Value

void

at line 111
static void releaseUniqueJobLocks()

No description

Return Value

void

at line 111
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 111
static QueueFake serializeAndRestore(bool $serializeAndRestore = 'true')

No description

Parameters

bool $serializeAndRestore

Return Value

QueueFake

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

No description

Parameters

object|string $job

Return Value

bool

at line 111
static int totalDelayedSize()

No description

Return Value

int

at line 111
static int totalPendingSize()

No description

Return Value

int

at line 111
static int totalReservedSize()

No description

Return Value

int

at line 111
static int totalSize()

No description

Return Value

int