SMW\MediaWiki\Job Class Reference

Inheritance diagram for SMW\MediaWiki\Job:

Collaboration diagram for SMW\MediaWiki\Job:

Public Member Functions
	setStore (Store $store)
	isEnabledJobQueue ( $enableJobQueue=true)
	pushToJobQueue ()
	getType ()
	getJobCount ()
	hasParameter ( $key)
	getParameter ( $key, $default=false)
	setParameter ( $key, $value)
	insert ()
	lazyPush ()
	setDelay ( $delay)
	ignoreDuplicates ()
	waitOnCommandLineMode ()

Static Public Member Functions
static	batchInsert ( $jobs)
static	newRootJobParams ( $key='', $title='')

Protected Member Functions
	getJobQueue ()

Protected Attributes
	$isEnabledJobQueue = true
	$jobQueue
	$jobs = []
	$store = null

Detailed Description

GNU GPL v2+

Since

1.9

Author

mwjames

Member Function Documentation

batchInsert()

static SMW\MediaWiki\Job::batchInsert (   $jobs )

static

See also

https://gerrit.wikimedia.org/r/#/c/162009

Parameters

self[]

$jobs

Returns

boolean

getJobCount()

SMW\MediaWiki\Job::getJobCount

(

)

Since

2.0

Returns

integer

getParameter()

SMW\MediaWiki\Job::getParameter	(		$key,
			$default = false
	)

Since

1.9

Parameters

mixed

$key

Returns

boolean

getType()

SMW\MediaWiki\Job::getType

(

)

Note

Job::getType was introduced with MW 1.21

Returns

string

hasParameter()

SMW\MediaWiki\Job::hasParameter

(

$key

)

Since

1.9

Parameters

mixed

$key

Returns

boolean

ignoreDuplicates()

SMW\MediaWiki\Job::ignoreDuplicates

(

)

See also

Job::ignoreDuplicates

Since

3.0

insert()

SMW\MediaWiki\Job::insert

(

)

See also

Job::insert

isEnabledJobQueue()

SMW\MediaWiki\Job::isEnabledJobQueue

(

$enableJobQueue = true

)

Whether to insert jobs into the JobQueue is enabled or not

Since

1.9

Parameters

boolean | true

$enableJobQueue

Returns

AbstractJob

lazyPush()

SMW\MediaWiki\Job::lazyPush

(

)

See also

JobQueueGroup::lazyPush

Note

Registered jobs are pushed using JobQueueGroup::pushLazyJobs at the end of MediaWiki::restInPeace

Since

3.0

newRootJobParams()

static SMW\MediaWiki\Job::newRootJobParams (   $key = '',   $title = ''  )

static

See also

Job::newRootJobParams

Since

3.0

pushToJobQueue()

SMW\MediaWiki\Job::pushToJobQueue

(

)

Note

Job::batchInsert was deprecated in MW 1.21 JobQueueGroup::singleton()->push( $job );

Since

1.9

setDelay()

SMW\MediaWiki\Job::setDelay

(

$delay

)

See also

Translate::TTMServerMessageUpdateJob

Since

3.0

Parameters

integer

$delay

setParameter()

SMW\MediaWiki\Job::setParameter	(		$key,
			$value
	)

Since

3.0

Parameters

mixed	$key
mixed	$value

setStore()

SMW\MediaWiki\Job::setStore

(

Store

$store

)

Since

2.1

Parameters

Store

$store

waitOnCommandLineMode()

SMW\MediaWiki\Job::waitOnCommandLineMode

(

)

Only run the job via commandLine or the cronJob and avoid execution via Special:RunJobs as it can cause the script to timeout.

---

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

• Job.php