Semantic MediaWiki and related extensions
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
SMW\MediaWiki\Jobs\JobBase Class Reference
Collaboration diagram for SMW\MediaWiki\Jobs\JobBase:
Collaboration graph
[legend]

Public Member Functions

 setStore (Store $store)
 
 isEnabledJobQueue ($enableJobQueue=true)
 
 pushToJobQueue ()
 
 getType ()
 
 getJobCount ()
 
 getTitle ()
 
 hasParameter ($key)
 
 getParameter ($key)
 
 insert ()
 
 lazyPush ()
 

Static Public Member Functions

static batchInsert ($jobs)
 
static getQueueSizes ()
 

Protected Attributes

 $isEnabledJobQueue = true
 
 $jobs = array()
 
 $store = null
 

Detailed Description

GNU GPL v2+

Since
1.9
Author
mwjames

Member Function Documentation

static SMW\MediaWiki\Jobs\JobBase::batchInsert (   $jobs)
static
See also
https://gerrit.wikimedia.org/r/#/c/162009
Parameters
self[]$jobs
Returns
boolean
SMW\MediaWiki\Jobs\JobBase::getJobCount ( )
Since
2.0
Returns
integer
SMW\MediaWiki\Jobs\JobBase::getParameter (   $key)
Since
1.9
Parameters
mixed$key
Returns
boolean
static SMW\MediaWiki\Jobs\JobBase::getQueueSizes ( )
static
Since
2.5
Returns
array
SMW\MediaWiki\Jobs\JobBase::getTitle ( )
Note
Job::getTitle() in MW 1.19 does not exist
Since
1.9
Returns
Title
SMW\MediaWiki\Jobs\JobBase::getType ( )
Note
Job::getType was introduced with MW 1.21
Returns
string
SMW\MediaWiki\Jobs\JobBase::hasParameter (   $key)
Since
1.9
Parameters
mixed$key
Returns
boolean
SMW\MediaWiki\Jobs\JobBase::insert ( )
See also
Job::insert
SMW\MediaWiki\Jobs\JobBase::isEnabledJobQueue (   $enableJobQueue = true)

Whether to insert jobs into the JobQueue is enabled or not

Since
1.9
Parameters
boolean | true$enableJobQueue
Returns
JobBase
SMW\MediaWiki\Jobs\JobBase::lazyPush ( )
See also
JobQueueGroup::lazyPush
Note
Registered jobs are pushed using JobQueueGroup::pushLazyJobs at the end of MediaWiki::restInPeace
Since
3.0
SMW\MediaWiki\Jobs\JobBase::pushToJobQueue ( )
Note
Job::batchInsert was deprecated in MW 1.21 JobQueueGroup::singleton()->push( $job );
Since
1.9
SMW\MediaWiki\Jobs\JobBase::setStore ( Store  $store)
Since
2.1
Parameters
Store$store

Member Data Documentation

SMW\MediaWiki\Jobs\JobBase::$isEnabledJobQueue = true
protected
SMW\MediaWiki\Jobs\JobBase::$jobs = array()
protected
SMW\MediaWiki\Jobs\JobBase::$store = null
protected

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