Initial commit

lib/Resque/Job.php

@@ -0,0 +1,195 @@
+<?php
+require_once 'Job/Status.php';
+
+/**
+ * Resque job.
+ *
+ * @package		Resque/Job
+ * @author		Chris Boulton <chris.boulton@interspire.com>
+ * @copyright	(c) 2010 Chris Boulton
+ * @license		http://www.opensource.org/licenses/mit-license.php
+ */
+class Resque_Job
+{
+	/**
+	 * @var string The name of the queue that this job belongs to.
+	 */
+	public $queue;
+
+	/**
+	 * @var Resque_Worker Instance of the Resque worker running this job.
+	 */
+	public $worker;
+
+	/**
+	 * @var object Object containing details of the job.
+	 */
+	public $payload;
+
+	/**
+	 * Instantiate a new instance of a job.
+	 *
+	 * @param string $queue The queue that the job belongs to.
+	 * @param object $payload Object containing details of the job.
+	 */
+	public function __construct($queue, $payload)
+	{
+		$this->queue = $queue;
+		$this->payload = $payload;
+	}
+
+	/**
+	 * Create a new job and save it to the specified queue.
+	 *
+	 * @param string $queue The name of the queue to place the job in.
+	 * @param string $class The name of the class that contains the code to execute the job.
+	 * @param object $args Any optional arguments that should be passed when the job is executed. Pass as a class.
+	 * @param boolean $monitor Set to true to be able to monitor the status of a job.
+	 */
+	public static function create($queue, $class, $args = null, $monitor = false)
+	{
+		if($args !== null && !is_object($args)) {
+			throw new InvalidArgumentException(
+				'Supplied $args must be an object and an instance of stdClass.'
+			);
+		}
+		$id = md5(uniqid('', true));
+		Resque::push($queue, array(
+			'class'	=> $class,
+			'args'	=> $args,
+			'id'	=> $id,
+		));
+
+		if($monitor) {
+			Resque_Job_Status::create($id);
+		}
+
+		return $id;
+	}
+
+	/**
+	 * Find the next available job from the specified queue and return an
+	 * instance of Resque_Job for it.
+	 *
+	 * @param string $queue The name of the queue to check for a job in.
+	 * @return null|object Null when there aren't any waiting jobs, instance of Resque_Job when a job was found.
+	 */
+	public static function reserve($queue)
+	{
+		$payload = Resque::pop($queue);
+		if(!$payload) {
+			return false;
+		}
+
+		return new Resque_Job($queue, $payload);
+	}
+
+	/**
+	 * Update the status of the current job.
+	 *
+	 * @param int $status Status constant from Resque_Job_Status indicating the current status of a job.
+	 */
+	public function updateStatus($status)
+	{
+		if(empty($this->payload->id)) {
+			return;
+		}
+
+		$statusInstance = new Resque_Job_Status($this->payload->id);
+		$statusInstance->update($status);
+	}
+
+	/**
+	 * Return the status of the current job.
+	 *
+	 * @return int The status of the job as one of the Resque_Job_Status constants.
+	 */
+	public function getStatus()
+	{
+		$status = new Resque_Job_Status($this->payload->id);
+		return $status->get();
+	}
+
+	/**
+	 * Actually execute a job by calling the perform method on the class
+	 * associated with the job with the supplied arguments.
+	 *
+	 * @throws Resque_Exception When the job's class could not be found or it does not contain a perform method.
+	 */
+	public function perform()
+	{
+		if(!class_exists($this->payload->class)) {
+			throw new Resque_Exception(
+				'Could not find job class ' . $this->payload->class . '.'
+			);
+		}
+
+		if(!method_exists($this->payload->class, 'perform')) {
+			throw new Resque_Exception(
+				'Job class ' . $this->payload->class . ' does not contain a perform method.'
+			);
+		}
+
+		call_user_func(array($this->payload->class, 'perform'), $this->payload->args);
+	}
+
+	/**
+	 * Mark the current job as having failed.
+	 */
+	public function fail($exception)
+	{
+		$this->updateStatus(Resque_Job_Status::STATUS_FAILED);
+		require_once 'Failure.php';
+		Resque_Failure::create(
+			$this->payload,
+			$exception,
+			$this->worker,
+			$this->queue
+		);
+		Resque_Stat::incr('failed');
+		Resque_Stat::incr('failed:' . $this->worker);
+	}
+
+	/**
+	 * Re-queue the current job.
+	 */
+	public function recreate()
+	{
+		$status = new Resque_Job_Status($this->payload->id);
+		$monitor = false;
+		if($status->isTracking()) {
+			$monitor = true;
+		}
+
+		return self::create($this->queue, $this->payload->class, $this->payload->args, $monitor);
+	}
+
+	/**
+	 * Generate a string representation used to describe the current job.
+	 *
+	 * @return string The string representation of the job.
+	 */
+	public function __toString()
+	{
+		$args = array();
+		if(isset($this->payload->args)) {
+			$args = $this->payload->args;
+			foreach($args as $k => $v) {
+				if(is_object($v)) {
+					$args[$k] = '{' . get_class($v) . ' - '.implode(',', get_object_vars($v)) . '}';
+				}
+			}
+		}
+
+		$name = array(
+			'Job{' . $this->queue .'}'
+		);
+		if(!empty($this->payload->id)) {
+			$name[] = 'ID: ' . $this->payload->id;
+		}
+		$name[] = $this->payload->class;
+		$name[] = implode(',', $args);
+		return '(' . implode(' | ', $name) . ')';
+	}
+}
+?>