PHP Class Resque\Job

Mostra file Open project: mjphaynes/php-resque Class Usage Examples

Protected Properties

Property Type Description
$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

Public Methods

Method Description
__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

Protected Methods

Method Description
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

Method Details

__construct() public method

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() public method

Generate a string representation of this object
public __toString ( ) : string
return string Representation of the current job status class

cancel() public method

Mark the current job as cancelled
public cancel ( )

cleanup() public static method

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() public method

Mark the current job as complete
public complete ( )

create() public static method

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
return string

createId() public static method

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
return string

createPayload() protected method

Create a payload string from the given job and data
protected createPayload ( ) : string
return string

delay() public method

Save the job to Redis delayed queue
public delay ( integer $time ) : boolean
$time integer unix time of when to perform job
return boolean success

execTime() public method

Returns formatted execution time string
public execTime ( ) : string
return string

execTimeStr() public method

Returns formatted execution time string
public execTimeStr ( ) : string
return string

fail() public method

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

failError() public method

Returns the fail error for the job
public failError ( ) : mixed
return mixed

getClass() public method

Get the job class.
public getClass ( ) : string
return string

getData() public method

Get the job data.
public getData ( ) : array
return array

getDelayedTime() public method

Get the job delayed time
public getDelayedTime ( ) : integer
return integer

getId() public method

Get the job id.
public getId ( ) : string
return string

getInstance() public method

Get the instantiated object for this job that will be performing work
public getInstance ( ) : object
return object Instance of the object that this job belongs to

getPacket() public method

Fetch the packet for the job being monitored.
public getPacket ( ) : array
return array

getQueue() public method

Get the job queue.
public getQueue ( ) : string
return string

getStatus() public method

Fetch the status for the job
public getStatus ( ) : integer
return integer Status as as an integer, based on the Job constants

getWorker() public method

Get the queue worker interface
public getWorker ( ) : Worker
return Worker

load() public static method

Load a job from id
public static load ( string $id ) : string
$id string The job id
return string

loadPayload() public static method

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
return string

perform() public method

Perform the job
public perform ( ) : boolean
return boolean

queue() public method

Save the job to Redis queue
public queue ( ) : boolean
return boolean success

redisKey() public static method

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
return string

run() public method

Mark the current job running
public run ( )

setClass() public method

Set the job class.
public setClass ( )

setData() public method

Set the job data.
public setData ( )

setId() public method

Set the job id.
public setId ( )

setQueue() public method

Set the job queue.
public setQueue ( )

setStatus() public method

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() public method

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

stopped() protected method

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

toArray() public method

Return array representation of this job
public toArray ( ) : array
return array

Property Details

$class protected_oe property

The classname this job
protected $class

$completeStatuses protected_oe static_oe property

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

$data protected_oe property

The data/arguments for the job
protected $data

$id protected_oe property

The ID of this job
protected $id

$instance protected_oe property

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

$method protected_oe property

The method name for this job
protected $method

$payload protected_oe property

The payload sent through for this job
protected $payload

$queue protected_oe property

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

$redis protected_oe property

The Redis instance
protected $redis

$worker protected_oe property

Instance of the worker running this job
protected $worker