class QueueFake extends QueueManager implements Queue (View source)

Properties

protected Application $app The application instance. from QueueManager
protected array $connections The array of resolved queue connections. from QueueManager
protected array $connectors The array of resolved queue connectors. from QueueManager
protected array $jobs All of the jobs that have been pushed.

Methods

void
__construct(Application $app)

Create a new queue manager instance.

void
before(mixed $callback)

Register an event listener for the before job event.

void
after(mixed $callback)

Register an event listener for the after job event.

void
exceptionOccurred(mixed $callback)

Register an event listener for the exception occurred job event.

void
looping(mixed $callback)

Register an event listener for the daemon queue loop.

void
failing(mixed $callback)

Register an event listener for the failed job event.

void
stopping(mixed $callback)

Register an event listener for the daemon queue stopping.

bool
connected(string $name = null)

Determine if the driver is connected.

connection(mixed $value = null)

Resolve a queue connection instance.

resolve(string $name)

Resolve a queue connection.

getConnector(string $driver)

Get the connector for a given driver.

void
extend(string $driver, Closure $resolver)

Add a queue connection resolver.

void
addConnector(string $driver, Closure $resolver)

Add a queue connection resolver.

array
getConfig(string $name)

Get the queue connection configuration.

string
getDefaultDriver()

Get the name of the default queue connection.

void
setDefaultDriver(string $name)

Set the name of the default queue connection.

string
getName(string $connection = null)

Get the full name for the given connection.

bool
isDownForMaintenance()

Determine if the application is in maintenance mode.

mixed
__call(string $method, array $parameters)

Dynamically pass calls to the default connection.

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

Assert if a job was pushed based on a truth-test callback.

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

Assert if a job was pushed a number of times.

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

Assert if a job was pushed based on a truth-test callback.

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

Assert if a job was pushed with chained jobs based on a truth-test callback.

void
assertPushedWithChainOfObjects(string $job, array $expectedChain, callable|null $callback)

Assert if a job was pushed with chained jobs based on a truth-test callback.

void
assertPushedWithChainOfClasses(string $job, array $expectedChain, callable|null $callback)

Assert if a job was pushed with chained jobs based on a truth-test callback.

bool
isChainOfObjects(array $chain)

Determine if the given chain is entirely composed of objects.

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

Determine if a job was pushed based on a truth-test callback.

void
assertNothingPushed()

Assert that no jobs were pushed.

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

Get all of the jobs matching a truth-test callback.

bool
hasPushed(string $job)

Determine if there are any stored jobs for a given class.

int
size(string $queue = null)

Get the size of the queue.

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

Push a new job onto the queue.

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

Push a raw payload onto the queue.

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

Push a new job onto the queue after a delay.

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

Push a new job onto the queue.

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

Push a new job onto the queue after a delay.

Job|null
pop(string $queue = null)

Pop the next job off of the queue.

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

Push an array of jobs onto the queue.

array
pushedJobs()

Get the jobs that have been pushed.

string
getConnectionName()

Get the connection name for the queue.

$this
setConnectionName(string $name)

Set the connection name for the queue.

Details

void __construct(Application $app)

Create a new queue manager instance.

Parameters

Application $app

Return Value

void

void before(mixed $callback)

Register an event listener for the before job event.

Parameters

mixed $callback

Return Value

void

void after(mixed $callback)

Register an event listener for the after job event.

Parameters

mixed $callback

Return Value

void

void exceptionOccurred(mixed $callback)

Register an event listener for the exception occurred job event.

Parameters

mixed $callback

Return Value

void

void looping(mixed $callback)

Register an event listener for the daemon queue loop.

Parameters

mixed $callback

Return Value

void

void failing(mixed $callback)

Register an event listener for the failed job event.

Parameters

mixed $callback

Return Value

void

void stopping(mixed $callback)

Register an event listener for the daemon queue stopping.

Parameters

mixed $callback

Return Value

void

bool connected(string $name = null)

Determine if the driver is connected.

Parameters

string $name

Return Value

bool

Queue connection(mixed $value = null)

Resolve a queue connection instance.

Parameters

mixed $value

Return Value

Queue

protected Queue resolve(string $name)

Resolve a queue connection.

Parameters

string $name

Return Value

Queue

protected ConnectorInterface getConnector(string $driver)

Get the connector for a given driver.

Parameters

string $driver

Return Value

ConnectorInterface

Exceptions

InvalidArgumentException

void extend(string $driver, Closure $resolver)

Add a queue connection resolver.

Parameters

string $driver
Closure $resolver

Return Value

void

void addConnector(string $driver, Closure $resolver)

Add a queue connection resolver.

Parameters

string $driver
Closure $resolver

Return Value

void

protected array getConfig(string $name)

Get the queue connection configuration.

Parameters

string $name

Return Value

array

string getDefaultDriver()

Get the name of the default queue connection.

Return Value

string

void setDefaultDriver(string $name)

Set the name of the default queue connection.

Parameters

string $name

Return Value

void

string getName(string $connection = null)

Get the full name for the given connection.

Parameters

string $connection

Return Value

string

bool isDownForMaintenance()

Determine if the application is in maintenance mode.

Return Value

bool

mixed __call(string $method, array $parameters)

Dynamically pass calls to the default connection.

Parameters

string $method
array $parameters

Return Value

mixed

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

Assert if a job was pushed based on a truth-test callback.

Parameters

string $job
callable|int|null $callback

Return Value

void

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

Assert if a job was pushed a number of times.

Parameters

string $job
int $times

Return Value

void

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

Assert if a job was pushed based on a truth-test callback.

Parameters

string $queue
string $job
callable|null $callback

Return Value

void

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

Assert if a job was pushed with chained jobs based on a truth-test callback.

Parameters

string $job
array $expectedChain
callable|null $callback

Return Value

void

protected void assertPushedWithChainOfObjects(string $job, array $expectedChain, callable|null $callback)

Assert if a job was pushed with chained jobs based on a truth-test callback.

Parameters

string $job
array $expectedChain
callable|null $callback

Return Value

void

protected void assertPushedWithChainOfClasses(string $job, array $expectedChain, callable|null $callback)

Assert if a job was pushed with chained jobs based on a truth-test callback.

Parameters

string $job
array $expectedChain
callable|null $callback

Return Value

void

protected bool isChainOfObjects(array $chain)

Determine if the given chain is entirely composed of objects.

Parameters

array $chain

Return Value

bool

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

Determine if a job was pushed based on a truth-test callback.

Parameters

string $job
callable|null $callback

Return Value

void

void assertNothingPushed()

Assert that no jobs were pushed.

Return Value

void

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

Get all of the jobs matching a truth-test callback.

Parameters

string $job
callable|null $callback

Return Value

Collection

bool hasPushed(string $job)

Determine if there are any stored jobs for a given class.

Parameters

string $job

Return Value

bool

int size(string $queue = null)

Get the size of the queue.

Parameters

string $queue

Return Value

int

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

Push a new job onto the queue.

Parameters

string|object $job
mixed $data
string $queue

Return Value

mixed

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

Push a raw payload onto the queue.

Parameters

string $payload
string $queue
array $options

Return Value

mixed

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

Push a new job onto the queue after a delay.

Parameters

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

Return Value

mixed

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

Push a new job onto the queue.

Parameters

string $queue
string|object $job
mixed $data

Return Value

mixed

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

Push a new job onto the queue after a delay.

Parameters

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

Return Value

mixed

Job|null pop(string $queue = null)

Pop the next job off of the queue.

Parameters

string $queue

Return Value

Job|null

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

Push an array of jobs onto the queue.

Parameters

array $jobs
mixed $data
string $queue

Return Value

mixed

array pushedJobs()

Get the jobs that have been pushed.

Return Value

array

string getConnectionName()

Get the connection name for the queue.

Return Value

string

$this setConnectionName(string $name)

Set the connection name for the queue.

Parameters

string $name

Return Value

$this