MediaWiki  master
RecentChangesUpdateJob Class Reference

Job for pruning recent changes. More...

Inheritance diagram for RecentChangesUpdateJob:
Collaboration diagram for RecentChangesUpdateJob:

Public Member Functions

 __construct (Title $title, array $params)
 
 run ()
 Run the job. More...
 
- Public Member Functions inherited from Job
 __construct ( $command, $params=null)
 
 allowRetries ()
 
Returns
bool Whether this job can be retried on failure by job runners
Since
1.21
More...
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 getLastError ()
 
Returns
string
More...
 
 getMetadata ( $field=null)
 
 getParams ()
 
Returns
array Parameters that specify sources, targets, and options for execution
More...
 
 getQueuedTimestamp ()
 
 getReadyTimestamp ()
 
Returns
int|null UNIX timestamp of when the job was runnable, or null
Since
1.26
More...
 
 getReleaseTimestamp ()
 
 getRequestId ()
 
Returns
string|null Id of the request that created this job. Follows jobs recursively, allowing to track the id of the request that started a job when jobs insert jobs which insert other jobs.
Since
1.27
More...
 
 getRootJobParams ()
 
 getTitle ()
 
 getType ()
 
Returns
string Job type that defines what sort of changes this job makes
More...
 
 hasExecutionFlag ( $flag)
 
Parameters
int$flagJOB_* class constant
Returns
bool
Since
1.31
More...
 
 hasRootJobParams ()
 
 ignoreDuplicates ()
 Whether the queue should reject insertion of this job if a duplicate exists. More...
 
 isRootJob ()
 
 setMetadata ( $field, $value)
 
 teardown ( $status)
 
 toString ()
 
Returns
string Debugging string describing the job
More...
 
 workItemCount ()
 
- Public Member Functions inherited from RunnableJob
 tearDown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 

Static Public Member Functions

static newCacheUpdateJob ()
 
static newPurgeJob ()
 
- Static Public Member Functions inherited from Job
static factory ( $command, $params=[])
 Create the appropriate object to handle a specific job. More...
 
static newRootJobParams ( $key)
 Get "root job" parameters for a task. More...
 

Protected Member Functions

 purgeExpiredRows ()
 
 updateActiveUsers ()
 
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 
 setLastError ( $error)
 

Additional Inherited Members

- Public Attributes inherited from Job
string $command
 
array $metadata = []
 Additional queue metadata. More...
 
array $params
 Array of job parameters. More...
 
- Protected Attributes inherited from Job
string $error
 Text for error that occurred last. More...
 
int $executionFlags = 0
 Bitfield of JOB_* class constants. More...
 
bool $removeDuplicates = false
 Expensive jobs may set this to true. More...
 
callable[] $teardownCallbacks = []
 
Title $title
 

Detailed Description

Job for pruning recent changes.

Since
1.25

Definition at line 29 of file RecentChangesUpdateJob.php.

Constructor & Destructor Documentation

◆ __construct()

RecentChangesUpdateJob::__construct ( Title  $title,
array  $params 
)

Definition at line 30 of file RecentChangesUpdateJob.php.

References Job\$params, and Job\$title.

Member Function Documentation

◆ newCacheUpdateJob()

static RecentChangesUpdateJob::newCacheUpdateJob ( )
staticfinal
Returns
RecentChangesUpdateJob
Since
1.26

Definition at line 54 of file RecentChangesUpdateJob.php.

References SpecialPage\getTitleFor().

Referenced by RecentChange\save().

◆ newPurgeJob()

static RecentChangesUpdateJob::newPurgeJob ( )
staticfinal
Returns
RecentChangesUpdateJob

Definition at line 44 of file RecentChangesUpdateJob.php.

References SpecialPage\getTitleFor().

Referenced by RecentChange\save().

◆ purgeExpiredRows()

RecentChangesUpdateJob::purgeExpiredRows ( )
protected

◆ run()

RecentChangesUpdateJob::run ( )

Run the job.

Returns
bool Success

Implements RunnableJob.

Definition at line 60 of file RecentChangesUpdateJob.php.

References purgeExpiredRows(), and updateActiveUsers().

◆ updateActiveUsers()

RecentChangesUpdateJob::updateActiveUsers ( )
protected

Definition at line 118 of file RecentChangesUpdateJob.php.

References $res, $wgActiveUserDays, DB_PRIMARY, NS_USER, RC_EXTERNAL, wfGetDB(), and wfTimestamp().

Referenced by run().


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