MediaWiki  REL1_31
CategoryMembershipChangeJob Class Reference

Job to add recent change entries mentioning category membership changes. More...

Inheritance diagram for CategoryMembershipChangeJob:
Collaboration diagram for CategoryMembershipChangeJob:

Public Member Functions

 __construct (Title $title, array $params)
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 run ()
 Run the job. More...
- Public Member Functions inherited from Job
 __construct ( $command, $title, $params=false)
 allowRetries ()
 getLastError ()
 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. More...
 insert ()
 Insert a single job into the queue. More...
 isRootJob ()
 teardown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 toString ()
 workItemCount ()

Public Attributes

- Public Attributes inherited from Job
string $command
array $metadata = []
 Additional queue metadata. More...
array $params
 Array of job parameters. More...

Protected Member Functions

 notifyUpdatesForRevision (LBFactory $lbFactory, WikiPage $page, Revision $newRev)
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 setLastError ( $error)

Private Member Functions

 getCategoriesAtRev (Title $title, Revision $rev, $parseTimestamp)
 getExplicitCategoriesChanges (Title $title, Revision $newRev, Revision $oldRev=null)

Private Attributes

int null $ticket

Additional Inherited Members

- Static Public Member Functions inherited from Job
static batchInsert ( $jobs)
 Batch-insert a group of jobs into the queue. More...
static factory ( $command, Title $title, $params=[])
 Create the appropriate object to handle a specific job. More...
static newRootJobParams ( $key)
 Get "root job" parameters for a task. 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
 Expensive jobs may set this to true. More...
callable[] $teardownCallbacks = []
Title $title

Detailed Description

Job to add recent change entries mentioning category membership changes.

This allows users to easily scan categories for recent page membership changes

Parameters include:

  • pageId : page ID
  • revTimestamp : timestamp of the triggering revision

Category changes will be mentioned for revisions at/after the timestamp for this page


Definition at line 38 of file CategoryMembershipChangeJob.php.

Constructor & Destructor Documentation

◆ __construct()

CategoryMembershipChangeJob::__construct ( Title  $title,
array  $params 

Definition at line 44 of file CategoryMembershipChangeJob.php.

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

Member Function Documentation

◆ getCategoriesAtRev()

CategoryMembershipChangeJob::getCategoriesAtRev ( Title  $title,
Revision  $rev,
string[] category names

Definition at line 234 of file CategoryMembershipChangeJob.php.

References $options, $output, $rev, and Job\$title.

Referenced by getExplicitCategoriesChanges().

◆ getDeduplicationInfo()

CategoryMembershipChangeJob::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.

array Map of key/values

Reimplemented from Job.

Definition at line 247 of file CategoryMembershipChangeJob.php.

◆ getExplicitCategoriesChanges()

CategoryMembershipChangeJob::getExplicitCategoriesChanges ( Title  $title,
Revision  $newRev,
Revision  $oldRev = null 

◆ notifyUpdatesForRevision()

CategoryMembershipChangeJob::notifyUpdatesForRevision ( LBFactory  $lbFactory,
WikiPage  $page,
Revision  $newRev 

◆ run()

CategoryMembershipChangeJob::run ( )

Member Data Documentation

◆ $ticket

int null CategoryMembershipChangeJob::$ticket

Definition at line 40 of file CategoryMembershipChangeJob.php.


const CategoryMembershipChangeJob::ENQUEUE_FUDGE_SEC = 60

Definition at line 42 of file CategoryMembershipChangeJob.php.

Referenced by run().

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