1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Testing
  7. \
  8. Fakes
  9. \
  10. QueueFake

QueueFake

class QueueFake extends QueueManager implements Queue

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.

from  QueueManager
void
before(mixed $callback)

Register an event listener for the before job event.

from  QueueManager
void
after(mixed $callback)

Register an event listener for the after job event.

from  QueueManager
void
exceptionOccurred(mixed $callback)

Register an event listener for the exception occurred job event.

from  QueueManager
void
looping(mixed $callback)

Register an event listener for the daemon queue loop.

from  QueueManager
void
failing(mixed $callback)

Register an event listener for the failed job event.

from  QueueManager
void
stopping(mixed $callback)

Register an event listener for the daemon queue stopping.

from  QueueManager
bool
connected(string $name = null)

Determine if the driver is connected.

from  QueueManager
Queue
connection(mixed $value = null)

Resolve a queue connection instance.

Queue
resolve(string $name)

Resolve a queue connection.

from  QueueManager
ConnectorInterface
getConnector(string $driver)

Get the connector for a given driver.

from  QueueManager
void
extend(string $driver, Closure $resolver)

Add a queue connection resolver.

from  QueueManager
void
addConnector(string $driver, Closure $resolver)

Add a queue connection resolver.

from  QueueManager
array
getConfig(string $name)

Get the queue connection configuration.

from  QueueManager
string
getDefaultDriver()

Get the name of the default queue connection.

from  QueueManager
void
setDefaultDriver(string $name)

Set the name of the default queue connection.

from  QueueManager
string
getName(string $connection = null)

Get the full name for the given connection.

from  QueueManager
bool
isDownForMaintenance()

Determine if the application is in maintenance mode.

from  QueueManager
mixed
__call(string $method, array $parameters)

Dynamically pass calls to the default connection.

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

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

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

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

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

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

Collection
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 $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(DateTime|int $delay, string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue after a delay.

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

Push a new job onto the queue.

mixed
laterOn(string $queue, DateTime|int $delay, string $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.

string
getConnectionName()

Get the connection name for the queue.

$this
setConnectionName(string $name)

Set the connection name for the queue.

Details

in QueueManager at line 42
void __construct(Application $app)

Create a new queue manager instance.

Parameters

Application $app

Return Value

void

in QueueManager at line 53
void before(mixed $callback)

Register an event listener for the before job event.

Parameters

mixed $callback

Return Value

void

in QueueManager at line 64
void after(mixed $callback)

Register an event listener for the after job event.

Parameters

mixed $callback

Return Value

void

in QueueManager at line 75
void exceptionOccurred(mixed $callback)

Register an event listener for the exception occurred job event.

Parameters

mixed $callback

Return Value

void

in QueueManager at line 86
void looping(mixed $callback)

Register an event listener for the daemon queue loop.

Parameters

mixed $callback

Return Value

void

in QueueManager at line 97
void failing(mixed $callback)

Register an event listener for the failed job event.

Parameters

mixed $callback

Return Value

void

in QueueManager at line 108
void stopping(mixed $callback)

Register an event listener for the daemon queue stopping.

Parameters

mixed $callback

Return Value

void

in QueueManager at line 119
bool connected(string $name = null)

Determine if the driver is connected.

Parameters

string $name

Return Value

bool

at line 106
Queue connection(mixed $value = null)

Resolve a queue connection instance.

Parameters

mixed $value

Return Value

Queue

in QueueManager at line 152
protected Queue resolve(string $name)

Resolve a queue connection.

Parameters

string $name

Return Value

Queue

in QueueManager at line 169
protected ConnectorInterface getConnector(string $driver)

Get the connector for a given driver.

Parameters

string $driver

Return Value

ConnectorInterface

Exceptions

InvalidArgumentException

in QueueManager at line 185
void extend(string $driver, Closure $resolver)

Add a queue connection resolver.

Parameters

string $driver
Closure $resolver

Return Value

void

in QueueManager at line 197
void addConnector(string $driver, Closure $resolver)

Add a queue connection resolver.

Parameters

string $driver
Closure $resolver

Return Value

void

in QueueManager at line 208
protected array getConfig(string $name)

Get the queue connection configuration.

Parameters

string $name

Return Value

array

in QueueManager at line 222
string getDefaultDriver()

Get the name of the default queue connection.

Return Value

string

in QueueManager at line 233
void setDefaultDriver(string $name)

Set the name of the default queue connection.

Parameters

string $name

Return Value

void

in QueueManager at line 244
string getName(string $connection = null)

Get the full name for the given connection.

Parameters

string $connection

Return Value

string

in QueueManager at line 254
bool isDownForMaintenance()

Determine if the application is in maintenance mode.

Return Value

bool

in QueueManager at line 266
mixed __call(string $method, array $parameters)

Dynamically pass calls to the default connection.

Parameters

string $method
array $parameters

Return Value

mixed

at line 25
void assertPushed(string $job, callable|null $callback = null)

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

Parameters

string $job
callable|null $callback

Return Value

void

at line 41
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

at line 59
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

at line 74
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

at line 95
bool hasPushed(string $job)

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

Parameters

string $job

Return Value

bool

at line 117
int size(string $queue = null)

Get the size of the queue.

Parameters

string $queue

Return Value

int

at line 130
mixed push(string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue.

Parameters

string $job
mixed $data
string $queue

Return Value

mixed

at line 146
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

at line 160
mixed later(DateTime|int $delay, string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue after a delay.

Parameters

DateTime|int $delay
string $job
mixed $data
string $queue

Return Value

mixed

at line 173
mixed pushOn(string $queue, string $job, mixed $data = '')

Push a new job onto the queue.

Parameters

string $queue
string $job
mixed $data

Return Value

mixed

at line 187
mixed laterOn(string $queue, DateTime|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

Parameters

string $queue
DateTime|int $delay
string $job
mixed $data

Return Value

mixed

at line 198
Job|null pop(string $queue = null)

Pop the next job off of the queue.

Parameters

string $queue

Return Value

Job|null

at line 211
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

at line 223
string getConnectionName()

Get the connection name for the queue.

Return Value

string

at line 234
$this setConnectionName(string $name)

Set the connection name for the queue.

Parameters

string $name

Return Value

$this