class BeanstalkdQueue extends Queue implements Queue (View source)

Traits

Properties

protected Container $container The IoC container instance. from Queue
protected string $connectionName The connection name for the queue. from Queue
static protected callable[] $createPayloadCallbacks The create payload callbacks. from Queue
protected Pheanstalk $pheanstalk The Pheanstalk instance.
protected string $default The name of the default tube.
protected int $timeToRun The "time to run" for all pushed jobs.
protected int $blockFor The maximum number of seconds to block for a job.

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

int
currentTime()

Get the current system time as a UNIX timestamp.

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

Push a new job onto the queue.

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

Push a new job onto the queue after a delay.

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

Push an array of jobs onto the queue.

from Queue
string
createPayload(string $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.

from Queue
array
createPayloadArray(mixed $job, string $queue, mixed $data = '')

Create a payload array from the given job and data.

from Queue
array
createObjectPayload(mixed $job, string $queue)

Create a payload for an object-based queue handler.

from Queue
string
getDisplayName(mixed $job)

Get the display name for the given job.

from Queue
mixed
getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

from Queue
array
createStringPayload(string $job, string $queue, mixed $data)

Create a typical, string based queue payload array.

from Queue
static void
createPayloadUsing(callable $callback)

Register a callback to be executed when creating job payloads.

from Queue
array
withCreatePayloadHooks(string $queue, array $payload)

Create the given payload using any registered payload hooks.

from Queue
string
getConnectionName()

Get the connection name for the queue.

from Queue
$this
setConnectionName(string $name)

Set the connection name for the queue.

from Queue
void
setContainer(Container $container)

Set the IoC container instance.

from Queue
void
__construct(Pheanstalk $pheanstalk, string $default, int $timeToRun, int $blockFor = 0)

Create a new Beanstalkd queue instance.

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.

Job|null
pop(string $queue = null)

Pop the next job off of the queue.

void
deleteMessage(string $queue, string $id)

Delete a message from the Beanstalk queue.

string
getQueue(string|null $queue)

Get the queue or return the default.

Pheanstalk
getPheanstalk()

Get the underlying Pheanstalk instance.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

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

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

Push a new job onto the queue after a delay.

Parameters

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

Return Value

mixed

void 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

void

protected string createPayload(string $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.

Parameters

string $job
string $queue
mixed $data

Return Value

string

Exceptions

InvalidPayloadException

protected array createPayloadArray(mixed $job, string $queue, mixed $data = '')

Create a payload array from the given job and data.

Parameters

mixed $job
string $queue
mixed $data

Return Value

array

protected array createObjectPayload(mixed $job, string $queue)

Create a payload for an object-based queue handler.

Parameters

mixed $job
string $queue

Return Value

array

protected string getDisplayName(mixed $job)

Get the display name for the given job.

Parameters

mixed $job

Return Value

string

mixed getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

protected array createStringPayload(string $job, string $queue, mixed $data)

Create a typical, string based queue payload array.

Parameters

string $job
string $queue
mixed $data

Return Value

array

static void createPayloadUsing(callable $callback)

Register a callback to be executed when creating job payloads.

Parameters

callable $callback

Return Value

void

protected array withCreatePayloadHooks(string $queue, array $payload)

Create the given payload using any registered payload hooks.

Parameters

string $queue
array $payload

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

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

void __construct(Pheanstalk $pheanstalk, string $default, int $timeToRun, int $blockFor = 0)

Create a new Beanstalkd queue instance.

Parameters

Pheanstalk $pheanstalk
string $default
int $timeToRun
int $blockFor

Return Value

void

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

Job|null pop(string $queue = null)

Pop the next job off of the queue.

Parameters

string $queue

Return Value

Job|null

void deleteMessage(string $queue, string $id)

Delete a message from the Beanstalk queue.

Parameters

string $queue
string $id

Return Value

void

string getQueue(string|null $queue)

Get the queue or return the default.

Parameters

string|null $queue

Return Value

string

Pheanstalk getPheanstalk()

Get the underlying Pheanstalk instance.

Return Value

Pheanstalk