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

Queue

class Queue 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 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 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
stopping(mixed $callback)

No description

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

No description

static Queue
connection(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(string $name)

No description

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

No description

static Application
getApplication()

No description

static QueueManager
setApplication(Application $app)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static mixed
laterOn(string $queue, DateInterval|int $delay, string|object $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 Container
getContainer()

No description

static void
setContainer(Container $container)

No description

static QueueFake
except(array|string $jobsToBeQueued)

No description

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

No description

static void
assertPushedOn(string $queue, Closure $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 $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

static bool
hasPushed(string $job)

No description

static bool
shouldFakeJob(object $job)

No description

static array
pushedJobs()

No description

static QueueFake
serializeAndRestore(bool $serializeAndRestore = true)

No description

Details

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

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 63
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 79
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 95
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 111
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 127
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 141
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 153
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 193
static protected bool isFake()

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

Return Value

bool

in Facade at line 206
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 96
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

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

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 260
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 270
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

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

Get the application instance behind the facade.

Return Value

Application|null

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

Set the application instance.

Parameters

Application|null $app

Return Value

void

in Facade at line 347
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 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 80
static QueueFake fake(array|string $jobsToFake = [])

Replace the bound instance with a fake.

Parameters

array|string $jobsToFake

Return Value

QueueFake

at line 60
static void before(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 60
static void after(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 60
static void exceptionOccurred(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 60
static void looping(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 60
static void failing(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 60
static void stopping(mixed $callback)

No description

Parameters

mixed $callback

Return Value

void

at line 60
static bool connected(string|null $name = null)

No description

Parameters

string|null $name

Return Value

bool

at line 60
static Queue connection(string|null $name = null)

No description

Parameters

string|null $name

Return Value

Queue

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

No description

Parameters

string $driver
Closure $resolver

Return Value

void

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

No description

Parameters

string $driver
Closure $resolver

Return Value

void

at line 60
static string getDefaultDriver()

No description

Return Value

string

at line 60
static void setDefaultDriver(string $name)

No description

Parameters

string $name

Return Value

void

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

No description

Parameters

string|null $connection

Return Value

string

at line 60
static Application getApplication()

No description

Return Value

Application

at line 60
static QueueManager setApplication(Application $app)

No description

Parameters

Application $app

Return Value

QueueManager

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

No description

Parameters

string|null $queue

Return Value

int

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

string $queue
string|object $job
mixed $data

Return Value

mixed

at line 60
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 60
static mixed later(DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)

No description

Parameters

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

Return Value

mixed

at line 60
static mixed laterOn(string $queue, DateInterval|int $delay, string|object $job, mixed $data = '')

No description

Parameters

string $queue
DateInterval|int $delay
string|object $job
mixed $data

Return Value

mixed

at line 60
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 60
static Job|null pop(string|null $queue = null)

No description

Parameters

string|null $queue

Return Value

Job|null

at line 60
static string getConnectionName()

No description

Return Value

string

at line 60
static Queue setConnectionName(string $name)

No description

Parameters

string $name

Return Value

Queue

at line 60
static mixed getJobTries(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

at line 60
static mixed getJobBackoff(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

at line 60
static mixed getJobExpiration(mixed $job)

No description

Parameters

mixed $job

Return Value

mixed

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

No description

Parameters

callable|null $callback

Return Value

void

at line 60
static Container getContainer()

No description

Return Value

Container

at line 60
static void setContainer(Container $container)

No description

Parameters

Container $container

Return Value

void

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

No description

Parameters

array|string $jobsToBeQueued

Return Value

QueueFake

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

No description

Parameters

Closure $job
callable|int|null $callback

Return Value

void

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

No description

Parameters

string $queue
Closure $job
callable|null $callback

Return Value

void

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

No description

Parameters

string $job
callable|null $callback

Return Value

void

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

No description

Parameters

callable|int|null $callback

Return Value

void

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

No description

Parameters

callable|null $callback

Return Value

void

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

No description

Parameters

Closure $job
callable|null $callback

Return Value

void

at line 60
static void assertCount(int $expectedCount)

No description

Parameters

int $expectedCount

Return Value

void

at line 60
static void assertNothingPushed()

No description

Return Value

void

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

No description

Parameters

string $job
callable|null $callback

Return Value

Collection

at line 60
static bool hasPushed(string $job)

No description

Parameters

string $job

Return Value

bool

at line 60
static bool shouldFakeJob(object $job)

No description

Parameters

object $job

Return Value

bool

at line 60
static array pushedJobs()

No description

Return Value

array

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

No description

Parameters

bool $serializeAndRestore

Return Value

QueueFake