Job queue task description base code. More...

Inheritance diagram for JobSpecification:

Collaboration diagram for JobSpecification:

Public Member Functions
	__construct ($type, array $params, array $opts=array(), Title $title=null)
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.
	getParams ()
	getReleaseTimestamp ()
	getTitle ()
	getType ()
	ignoreDuplicates ()
Protected Member Functions
	validateParams (array $params)
Protected Attributes
bool	$ignoreDuplicates
	Expensive jobs may set this to true *.
array	$params
	Array of job parameters or false if none *.
Title	$title
	*
string	$type
	*

Detailed Description

Job queue task description base code.

Example usage: $job = new JobSpecification( 'null', array( 'lives' => 1, 'usleep' => 100, 'pi' => 3.141569 ), array( 'removeDuplicates' => 1 ), Title::makeTitle( NS_SPECIAL, 'nullity' ) ); JobQueueGroup::singleton()->push( $job )

Since:: 1.23

Definition at line 84 of file JobSpecification.php.

Constructor & Destructor Documentation

JobSpecification::__construct	(	$	type,
		array $	params,
		array $	opts = `array()`,
		Title $	title = `null`
	)

Parameters:

string	$type
array	$params	Map of key/values
array	$opts	Map of key/values
Title	$title	Optional descriptive title

Definition at line 99 of file JobSpecification.php.

Member Function Documentation

JobSpecification::getDeduplicationInfo ( )

Subclasses may need to override this to make duplication detection work.

The resulting map conveys everything that makes the job unique. This is only checked if ignoreDuplicates() returns true, meaning that duplicate jobs are supposed to be ignored.