PHP Класс Resque\Job

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$class The classname this job
$completeStatuses of statuses that are considered final/complete
$data The data/arguments for the job
$id The ID of this job
$instance Instance of the class performing work for this job
$method The method name for this job
$payload The payload sent through for this job
$queue The name of the queue that this job belongs to
$redis The Redis instance
$worker Instance of the worker running this job

Открытые методы

Метод Описание
__construct ( string $queue, string $id, string $class, array $data = null ) Create a new job
__toString ( ) : string Generate a string representation of this object
cancel ( ) Mark the current job as cancelled
cleanup ( array $queues = ['*'] ) Look for any jobs which are running but the worker is dead.
complete ( ) Mark the current job as complete
create ( string $queue, string $class, array $data = null, integer $run_at ) : string Create a new job and save it to the specified queue.
createId ( string $queue, string $class, array $data = null, integer $run_at ) : string Create a new job id
delay ( integer $time ) : boolean Save the job to Redis delayed queue
execTime ( ) : string Returns formatted execution time string
execTimeStr ( ) : string Returns formatted execution time string
fail ( Exception $e ) Mark the current job as having failed
failError ( ) : mixed Returns the fail error for the job
getClass ( ) : string Get the job class.
getData ( ) : array Get the job data.
getDelayedTime ( ) : integer Get the job delayed time
getId ( ) : string Get the job id.
getInstance ( ) : object Get the instantiated object for this job that will be performing work
getPacket ( ) : array Fetch the packet for the job being monitored.
getQueue ( ) : string Get the job queue.
getStatus ( ) : integer Fetch the status for the job
getWorker ( ) : Worker Get the queue worker interface
load ( string $id ) : string Load a job from id
loadPayload ( string $queue, string $payload ) : string Load a job from the Redis payload
perform ( ) : boolean Perform the job
queue ( ) : boolean Save the job to Redis queue
redisKey ( Job $job, string $suffix = null ) : string Get the Redis key
run ( ) Mark the current job running
setClass ( ) Set the job class.
setData ( ) Set the job data.
setId ( ) Set the job id.
setQueue ( ) Set the job queue.
setStatus ( integer $status, Exception $e = null ) Update the status indicator for the current job with a new status
setWorker ( Worker $worker ) Set the queue worker interface
toArray ( ) : array Return array representation of this job

Защищенные методы

Метод Описание
createPayload ( ) : string Create a payload string from the given job and data
stopped ( ) Mark the current job stopped This is an internal function as the job is either completed, cancelled or failed

Описание методов

__construct() публичный Метод

Create a new job
public __construct ( string $queue, string $id, string $class, array $data = null )
$queue string Queue to add job to
$id string Job id
$class string Job class to run
$data array Any Job data

__toString() публичный Метод

Generate a string representation of this object
public __toString ( ) : string
Результат string Representation of the current job status class

cancel() публичный Метод

Mark the current job as cancelled
public cancel ( )

cleanup() публичный статический Метод

Meaning that they are also not running but left in limbo This is a form of garbage collection to handle cases where the server may have been killed and the workers did not die gracefully and therefore leave state information in Redis.
public static cleanup ( array $queues = ['*'] )
$queues array list of queues to check

complete() публичный Метод

Mark the current job as complete
public complete ( )

create() публичный статический Метод

Create a new job and save it to the specified queue.
public static create ( string $queue, string $class, array $data = null, integer $run_at ) : string
$queue string The name of the queue to place the job in
$class string The name of the class that contains the code to execute the job
$data array Any optional arguments that should be passed when the job is executed
$run_at integer Unix timestamp of when to run the job to delay execution
Результат string

createId() публичный статический Метод

Create a new job id
public static createId ( string $queue, string $class, array $data = null, integer $run_at ) : string
$queue string The name of the queue to place the job in
$class string The name of the class that contains the code to execute the job
$data array Any optional arguments that should be passed when the job is executed
$run_at integer Unix timestamp of when to run the job to delay execution
Результат string

createPayload() защищенный Метод

Create a payload string from the given job and data
protected createPayload ( ) : string
Результат string

delay() публичный Метод

Save the job to Redis delayed queue
public delay ( integer $time ) : boolean
$time integer unix time of when to perform job
Результат boolean success

execTime() публичный Метод

Returns formatted execution time string
public execTime ( ) : string
Результат string

execTimeStr() публичный Метод

Returns formatted execution time string
public execTimeStr ( ) : string
Результат string

fail() публичный Метод

Mark the current job as having failed
public fail ( Exception $e )
$e Exception

failError() публичный Метод

Returns the fail error for the job
public failError ( ) : mixed
Результат mixed

getClass() публичный Метод

Get the job class.
public getClass ( ) : string
Результат string

getData() публичный Метод

Get the job data.
public getData ( ) : array
Результат array

getDelayedTime() публичный Метод

Get the job delayed time
public getDelayedTime ( ) : integer
Результат integer

getId() публичный Метод

Get the job id.
public getId ( ) : string
Результат string

getInstance() публичный Метод

Get the instantiated object for this job that will be performing work
public getInstance ( ) : object
Результат object Instance of the object that this job belongs to

getPacket() публичный Метод

Fetch the packet for the job being monitored.
public getPacket ( ) : array
Результат array

getQueue() публичный Метод

Get the job queue.
public getQueue ( ) : string
Результат string

getStatus() публичный Метод

Fetch the status for the job
public getStatus ( ) : integer
Результат integer Status as as an integer, based on the Job constants

getWorker() публичный Метод

Get the queue worker interface
public getWorker ( ) : Worker
Результат Worker

load() публичный статический Метод

Load a job from id
public static load ( string $id ) : string
$id string The job id
Результат string

loadPayload() публичный статический Метод

Load a job from the Redis payload
public static loadPayload ( string $queue, string $payload ) : string
$queue string The name of the queue to place the job in
$payload string The payload that was stored in Redis
Результат string

perform() публичный Метод

Perform the job
public perform ( ) : boolean
Результат boolean

queue() публичный Метод

Save the job to Redis queue
public queue ( ) : boolean
Результат boolean success

redisKey() публичный статический Метод

Get the Redis key
public static redisKey ( Job $job, string $suffix = null ) : string
$job Job the job to get the key for
$suffix string to be appended to key
Результат string

run() публичный Метод

Mark the current job running
public run ( )

setClass() публичный Метод

Set the job class.
public setClass ( )

setData() публичный Метод

Set the job data.
public setData ( )

setId() публичный Метод

Set the job id.
public setId ( )

setQueue() публичный Метод

Set the job queue.
public setQueue ( )

setStatus() публичный Метод

Update the status indicator for the current job with a new status
public setStatus ( integer $status, Exception $e = null )
$status integer The status of the job
$e Exception If failed status it sends through exception

setWorker() публичный Метод

Set the queue worker interface
public setWorker ( Worker $worker )
$worker Worker

stopped() защищенный Метод

Mark the current job stopped This is an internal function as the job is either completed, cancelled or failed
protected stopped ( )

toArray() публичный Метод

Return array representation of this job
public toArray ( ) : array
Результат array

Описание свойств

$class защищенное свойство

The classname this job
protected $class

$completeStatuses защищенное статическое свойство

of statuses that are considered final/complete
protected static $completeStatuses

$data защищенное свойство

The data/arguments for the job
protected $data

$id защищенное свойство

The ID of this job
protected $id

$instance защищенное свойство

Instance of the class performing work for this job
protected $instance

$method защищенное свойство

The method name for this job
protected $method

$payload защищенное свойство

The payload sent through for this job
protected $payload

$queue защищенное свойство

The name of the queue that this job belongs to
protected $queue

$redis защищенное свойство

The Redis instance
protected $redis

$worker защищенное свойство

Instance of the worker running this job
protected $worker