No-op job that does nothing. More...

Inheritance diagram for DuplicateJob:

[legend]

Collaboration diagram for DuplicateJob:

[legend]

Public Member Functions
	__construct (array $params)
	Callers should use DuplicateJob::newFromJob() instead.

	run ()
	Run the job.

Public Member Functions inherited from Job
	__construct ( $command, $params=null)

	allowRetries ()

	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.

	getLastError ()

	getMetadata ( $field=null)

	getParams ()

	getQueuedTimestamp ()

	getReadyTimestamp ()

	getReleaseTimestamp ()

	getRequestId ()

	getRootJobParams ()

	getTitle ()

	getType ()

	hasExecutionFlag ( $flag)

	hasRootJobParams ()

	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists.

	isRootJob ()

	setMetadata ( $field, $value)

	teardown ( $status)

	toString ()

	workItemCount ()

Public Member Functions inherited from RunnableJob
	tearDown ( $status)
	Do any final cleanup after run(), deferred updates, and all DB commits happen.

Static Public Member Functions
static	newFromJob (RunnableJob $job)
	Get a duplicate no-op version of a job.

Static Public Member Functions inherited from Job
static	factory ( $command, $params=[])
	Create the appropriate object to handle a specific job.

static	newRootJobParams ( $key)
	Get "root job" parameters for a task.

Additional Inherited Members
Public Attributes inherited from Job
string	$command

array	$metadata = []
	Additional queue metadata.

array	$params
	Array of job parameters.

Protected Member Functions inherited from Job
	addTeardownCallback ( $callback)

	setLastError ( $error)

Protected Attributes inherited from Job
string	$error
	Text for error that occurred last.

int	$executionFlags = 0
	Bitfield of JOB_* class constants.

bool	$removeDuplicates = false
	Expensive jobs may set this to true.

callable[]	$teardownCallbacks = []

Title	$title

Detailed Description

No-op job that does nothing.

Used to represent duplicates.

Definition at line 29 of file DuplicateJob.php.

Constructor & Destructor Documentation

DuplicateJob::__construct ( array $params )

Callers should use DuplicateJob::newFromJob() instead.

Parameters

array $params Job parameters

Definition at line 35 of file DuplicateJob.php.

References Job\$params.

static DuplicateJob::newFromJob ( RunnableJob $job )

static

Get a duplicate no-op version of a job.

Parameters

RunnableJob $job

Definition at line 45 of file DuplicateJob.php.

References $job, and true.

Referenced by JobQueue\pop().

DuplicateJob::run ( )

Run the job.

Implements RunnableJob.

Definition at line 55 of file DuplicateJob.php.

The documentation for this class was generated from the following file: