MediaWiki  master
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 ()
 
- Public Member Functions inherited from Job
 __construct ($command, $title, $params=false)
 
 allowRetries ()
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 getLastError ()
 
 getParams ()
 
 getQueuedTimestamp ()
 
 getReadyTimestamp ()
 
 getReleaseTimestamp ()
 
 getRequestId ()
 
 getRootJobParams ()
 
 getTitle ()
 
 getType ()
 
 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 ()
 
 run ()
 Run the job. More...
 
 teardown ($status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 
 toString ()
 
 workItemCount ()
 

Public Attributes

const ENQUEUE_FUDGE_SEC = 60
 
- 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...
 
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.

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

Since
1.27

Definition at line 36 of file CategoryMembershipChangeJob.php.

Constructor & Destructor Documentation

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

Definition at line 42 of file CategoryMembershipChangeJob.php.

Member Function Documentation

CategoryMembershipChangeJob::getCategoriesAtRev ( Title  $title,
Revision  $rev,
  $parseTimestamp 
)
private
Parameters
Title$title
Revision$rev
string$parseTimestampTS_MW
Returns
string[] category names

Definition at line 224 of file CategoryMembershipChangeJob.php.

References $options, $output, Revision\getContent(), and Revision\getId().

Referenced by getExplicitCategoriesChanges().

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.

Returns
array Map of key/values

Implements IJobSpecification.

Definition at line 237 of file CategoryMembershipChangeJob.php.

CategoryMembershipChangeJob::getExplicitCategoriesChanges ( Title  $title,
Revision  $newRev,
Revision  $oldRev = null 
)
private
CategoryMembershipChangeJob::notifyUpdatesForRevision ( LBFactory  $lbFactory,
WikiPage  $page,
Revision  $newRev 
)
protected

Member Data Documentation

int null CategoryMembershipChangeJob::$ticket
private

Definition at line 38 of file CategoryMembershipChangeJob.php.

const CategoryMembershipChangeJob::ENQUEUE_FUDGE_SEC = 60

Definition at line 40 of file CategoryMembershipChangeJob.php.


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