Queue

class Queue 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 void

popUsing(string $workerName, callable $callback)

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

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

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

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 void popUsing(string $workerName, callable $callback)

Parameters

string	$workerName
callable	$callback

Return Value

void

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

Replace the bound instance with a fake.

Parameters

array|string

$jobsToFake

Return Value

QueueFake

static void before(mixed $callback)

No description

Parameters

mixed

$callback

Return Value

void

static void after(mixed $callback)

No description

Parameters

mixed

$callback

Return Value

void

static void exceptionOccurred(mixed $callback)

No description

Parameters

mixed

$callback

Return Value

void

static void looping(mixed $callback)

No description

Parameters

mixed

$callback

Return Value

void

static void failing(mixed $callback)

No description

Parameters

mixed

$callback

Return Value

void

static void stopping(mixed $callback)

No description

Parameters

mixed

$callback

Return Value

void

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

No description

Parameters

string|null

$name

Return Value

bool

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

No description

Parameters

string|null

$name

Return Value

Queue

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

No description

Parameters

string	$driver
Closure	$resolver

Return Value

void

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

No description

Parameters

string	$driver
Closure	$resolver

Return Value

void

static string getDefaultDriver()

No description

Return Value

string

static void setDefaultDriver(string $name)

No description

Parameters

string

$name

Return Value

void

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

No description

Parameters

string|null

$connection

Return Value

string

static Application getApplication()

No description

Return Value

Application

static QueueManager setApplication(Application $app)

No description

Parameters

Application

$app

Return Value

QueueManager

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

No description

Parameters

string|null

$queue

Return Value

int

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

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

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

Return Value

mixed

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

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

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

No description

Parameters

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

Return Value

mixed

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

No description

Parameters

string|null

$queue

Return Value

Job|null

static string getConnectionName()

No description

Return Value

string

static Queue setConnectionName(string $name)

No description

Parameters

string

$name

Return Value

Queue

static mixed getJobBackoff(mixed $job)

No description

Parameters

mixed

$job

Return Value

mixed

static mixed getJobExpiration(mixed $job)

No description

Parameters

mixed

$job

Return Value

mixed

static void createPayloadUsing(callable|null $callback)

No description

Parameters

callable|null

$callback

Return Value

void

static Container getContainer()

No description

Return Value

Container

static void setContainer(Container $container)

No description

Parameters

Container

$container

Return Value

void

static QueueFake except(array|string $jobsToBeQueued)

No description

Parameters

array|string

$jobsToBeQueued

Return Value

QueueFake

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

No description

Parameters

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

Return Value

void

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

No description

Parameters

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

Return Value

void

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

No description

Parameters

string	$job
array	$expectedChain
callable\|null	$callback

Return Value

void

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

No description

Parameters

string	$job
callable\|null	$callback

Return Value

void

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

No description

Parameters

callable|int|null

$callback

Return Value

void

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

No description

Parameters

callable|null

$callback

Return Value

void

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

No description

Parameters

Closure	$job
callable\|null	$callback

Return Value

void

static void assertNothingPushed()

No description

Return Value

void

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

No description

Parameters

string	$job
callable\|null	$callback

Return Value

Collection

static bool hasPushed(string $job)

No description

Parameters

string

$job

Return Value

bool

static bool shouldFakeJob(object $job)

No description

Parameters

object

$job

Return Value

bool

static array pushedJobs()

No description

Return Value

array

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