QueueFake
class QueueFake extends QueueManager implements Fake, Queue (View source)
Traits
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 |
| Queue | $queue | The original queue manager. |
|
| protected Collection | $jobsToFake | The job types that should be intercepted instead of pushed to the queue. |
|
| protected Collection | $jobsToBeQueued | The job types that should be pushed to the queue and not intercepted. |
|
| protected array | $jobs | All of the jobs that have been pushed. |
|
| protected RawPushType> | $rawPushes | All of the payloads that have been raw pushed. |
|
| protected bool | $serializeAndRestore | Indicates if items should be serialized and restored when pushed to the queue. |
Methods
Create a new fake queue instance.
Register an event listener for the exception occurred job event.
Register an event listener for the daemon queue loop.
Register an event listener for the failed job event.
Register an event listener for the daemon queue starting.
Register an event listener for the daemon queue stopping.
Resolve a queue connection instance.
Get the connector for a given driver.
Pause a queue by its connection and name.
Pause a queue by its connection and name for a given amount of time.
Resume a paused queue by its connection and name.
Indicate that queue workers should not poll for restart or pause signals.
Get the full name for the given connection.
Override the QueueManager to prevent circular dependency.
Get the class name of the first parameter of the given Closure.
Get the class names of the first parameter of the given Closure, including union types.
Get the class names / types of the parameters of the given Closure.
Get the class names / types of the return type of the given Closure.
Specify the jobs that should be queued instead of faked.
Assert if a job was pushed based on a truth-test callback.
Assert if a job was pushed a number of times.
Assert if a job was pushed based on a truth-test callback.
Assert if a job was pushed with chained jobs based on a truth-test callback.
Assert if a job was pushed with an empty chain based on a truth-test callback.
Assert if a job was pushed with chained jobs based on a truth-test callback.
Assert if a job was pushed with chained jobs based on a truth-test callback.
Assert if a closure was pushed based on a truth-test callback.
Assert that a closure was not pushed based on a truth-test callback.
Determine if the given chain is entirely composed of objects.
Determine if a job was pushed based on a truth-test callback.
Assert the total count of jobs that were pushed.
Assert that no jobs were pushed.
Get all of the jobs matching a truth-test callback.
Get all of the raw pushes matching a truth-test callback.
Get all of the jobs by listener class, passing an optional truth-test callback.
Determine if there are any stored jobs for a given class.
Get the size of the queue.
Get the number of pending jobs.
Get the number of delayed jobs.
Get the number of reserved jobs.
Get the creation timestamp of the oldest pending job, excluding delayed jobs.
Push a new job onto the queue.
Determine if a job should be faked or actually dispatched.
Determine if a job should be pushed to the queue instead of faked.
Push a raw payload onto the queue.
Push a new job onto the queue after (n) seconds.
Push a new job onto the queue.
Push a new job onto a specific queue after (n) seconds.
Push an array of jobs onto the queue.
Get the jobs that have been pushed.
Get the payloads that were pushed raw.
Specify if jobs should be serialized and restored when being "pushed" to the queue.
Serialize and unserialize the job to simulate the queueing process.
Get the connection name for the queue.
Set the connection name for the queue.
Details
__construct(Application $app, array $jobsToFake = [], QueueManager|null $queue = null)
Create a new fake queue 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
starting(mixed $callback)
Register an event listener for the daemon queue starting.
void
stopping(mixed $callback)
Register an event listener for the daemon queue stopping.
bool
connected(string|null $name = null)
Determine if the driver is connected.
Queue
connection(mixed $value = null)
Resolve a queue connection instance.
protected Queue
resolve(string $name)
Resolve a queue connection.
protected ConnectorInterface
getConnector(string $driver)
Get the connector for a given driver.
void
pause(string $connection, string $queue)
Pause a queue by its connection and name.
void
pauseFor(string $connection, string $queue, DateTimeInterface|DateInterval|int $ttl)
Pause a queue by its connection and name for a given amount of time.
void
resume(string $connection, string $queue)
Resume a paused queue by its connection and name.
bool
isPaused(string $connection, string $queue)
Determine if a queue is paused.
void
withoutInterruptionPolling()
Indicate that queue workers should not poll for restart or pause signals.
This prevents the workers from hitting the application cache to determine if they need to pause or restart.
void
extend(string $driver, Closure $resolver)
Add a queue connection resolver.
void
addConnector(string $driver, Closure $resolver)
Add a queue connection resolver.
protected array|null
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|null $connection = null)
Get the full name for the given connection.
Application
getApplication()
Get the application instance used by the manager.
$this
setApplication(Application $app)
Set the application instance used by the manager.
mixed
__call(string $method, array $parameters)
Override the QueueManager to prevent circular dependency.
protected string
firstClosureParameterType(Closure $closure)
Get the class name of the first parameter of the given Closure.
protected array
firstClosureParameterTypes(Closure $closure)
Get the class names of the first parameter of the given Closure, including union types.
protected array
closureParameterTypes(Closure $closure)
Get the class names / types of the parameters of the given Closure.
protected list<class-string>
closureReturnTypes(Closure $closure)
Get the class names / types of the return type of the given Closure.
$this
except(array|string $jobsToBeQueued)
Specify the jobs that should be queued instead of faked.
void
assertPushed(string|Closure $job, callable|int|null $callback = null)
Assert if a job was pushed based on a truth-test callback.
protected void
assertPushedTimes(string $job, int $times = 1)
Assert if a job was pushed a number of times.
void
assertPushedOn(string $queue, string|Closure $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
assertPushedWithoutChain(string $job, callable|null $callback = null)
Assert if a job was pushed with an empty chain based on a truth-test callback.
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.
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.
void
assertClosurePushed(callable|int|null $callback = null)
Assert if a closure was pushed based on a truth-test callback.
void
assertClosureNotPushed(callable|null $callback = null)
Assert that a closure was not pushed based on a truth-test callback.
protected bool
isChainOfObjects(array $chain)
Determine if the given chain is entirely composed of objects.
void
assertNotPushed(string|Closure $job, callable|null $callback = null)
Determine if a job was pushed based on a truth-test callback.
void
assertCount(int $expectedCount)
Assert the total count of jobs that were pushed.
void
assertNothingPushed()
Assert that no jobs were pushed.
Collection
pushed(string $job, callable|null $callback = null)
Get all of the jobs matching a truth-test callback.
RawPushType>
pushedRaw($callback = null)
Get all of the raw pushes matching a truth-test callback.
CallQueuedListener>
listenersPushed(class-string $listenerClass, $callback = null)
Get all of the jobs by listener class, passing an optional truth-test callback.
bool
hasPushed(string $job)
Determine if there are any stored jobs for a given class.
int
size(string|null $queue = null)
Get the size of the queue.
int
pendingSize(string|null $queue = null)
Get the number of pending jobs.
int
delayedSize(string|null $queue = null)
Get the number of delayed jobs.
int
reservedSize(string|null $queue = null)
Get the number of reserved jobs.
int|null
creationTimeOfOldestPendingJob(string|null $queue = null)
Get the creation timestamp of the oldest pending job, excluding delayed jobs.
mixed
push(string|object $job, mixed $data = '', string|null $queue = null)
Push a new job onto the queue.
bool
shouldFakeJob(object $job)
Determine if a job should be faked or actually dispatched.
protected bool
shouldDispatchJob(object $job)
Determine if a job should be pushed to the queue instead of faked.
mixed
pushRaw(string $payload, string|null $queue = null, array $options = [])
Push a raw payload onto the queue.
mixed
later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)
Push a new job onto the queue after (n) seconds.
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 a specific queue after (n) seconds.
Job|null
pop(string|null $queue = null)
Pop the next job off of the queue.
mixed
bulk(array $jobs, mixed $data = '', string|null $queue = null)
Push an array of jobs onto the queue.
array
pushedJobs()
Get the jobs that have been pushed.
RawPushType>
rawPushes()
Get the payloads that were pushed raw.
$this
serializeAndRestore(bool $serializeAndRestore = true)
Specify if jobs should be serialized and restored when being "pushed" to the queue.
protected mixed
serializeAndRestoreJob(mixed $job)
Serialize and unserialize the job to simulate the queueing process.
string
getConnectionName()
Get the connection name for the queue.
$this
setConnectionName(string $name)
Set the connection name for the queue.