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)
 Constructor for use by the Job Queue infrastructure. More...
 
 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, $params=null)
 Stable to call. More...
 
 allowRetries ()
 
Returns
bool Whether this job can be retried on failure by job runners
Since
1.21
Stable to override More...
 
 getLastError ()
 
Returns
string
Stable to override More...
 
 getMetadata ( $field=null)
 Stable to override. More...
 
 getParams ()
 
Returns
array Parameters that specify sources, targets, and options for execution
Stable to override More...
 
 getQueuedTimestamp ()
 
 getReadyTimestamp ()
 
Returns
int|null UNIX timestamp of when the job was runnable, or null
Since
1.26
Stable to override More...
 
 getReleaseTimestamp ()
 Stable to override. More...
 
 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
Stable to override More...
 
 getRootJobParams ()
 Stable to override. More...
 
 getTitle ()
 
 getType ()
 
Returns
string Job type that defines what sort of changes this job makes
Stable to override More...
 
 hasExecutionFlag ( $flag)
 
Parameters
int$flagJOB_* class constant
Returns
bool
Since
1.31
Stable to override More...
 
 hasRootJobParams ()
 Stable to override. More...
 
 ignoreDuplicates ()
 Whether the queue should reject insertion of this job if a duplicate exists. More...
 
 isRootJob ()
 Stable to override. More...
 
 setMetadata ( $field, $value)
 Stable to override. More...
 
 teardown ( $status)
 Stable to override More...
 
 toString ()
 
Returns
string Debugging string describing the job
Stable to override More...
 
 workItemCount ()
 Stable to override. More...
 
- 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 newSpec (Title $title, $revisionTimestamp)
 
- 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

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

Private Member Functions

 getCategoriesAtRev (WikiPage $page, RevisionRecord $rev, $parseTimestamp)
 
 getExplicitCategoriesChanges (WikiPage $page, RevisionRecord $newRev, RevisionRecord $oldRev=null)
 

Private Attributes

int null $ticket
 
const ENQUEUE_FUDGE_SEC = 60
 

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 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

Since
1.27

Definition at line 41 of file CategoryMembershipChangeJob.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor for use by the Job Queue infrastructure.

Note
Don't call this when queueing a new instance, use newSpec() instead.
Parameters
Title$titleTitle of the categorized page.
array$paramsSuch latest revision instance of the categorized page.

Definition at line 73 of file CategoryMembershipChangeJob.php.

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

Member Function Documentation

◆ getCategoriesAtRev()

CategoryMembershipChangeJob::getCategoriesAtRev ( WikiPage  $page,
RevisionRecord  $rev,
  $parseTimestamp 
)
private
Parameters
WikiPage$page
RevisionRecord$rev
string$parseTimestampTS_MW
Returns
string[] category names

Definition at line 264 of file CategoryMembershipChangeJob.php.

References Revision\RevisionRecord\getId(), Revision\RevisionRecord\isCurrent(), and WikiPage\makeParserOptions().

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.

Stable to override

Returns
array Map of key/values
Since
1.21

Reimplemented from Job.

Definition at line 283 of file CategoryMembershipChangeJob.php.

◆ getExplicitCategoriesChanges()

CategoryMembershipChangeJob::getExplicitCategoriesChanges ( WikiPage  $page,
RevisionRecord  $newRev,
RevisionRecord  $oldRev = null 
)
private

◆ newSpec()

static CategoryMembershipChangeJob::newSpec ( Title  $title,
  $revisionTimestamp 
)
static
Parameters
Title$titleThe title of the page for which to update category membership.
string$revisionTimestampThe timestamp of the new revision that triggered the job.
Returns
JobSpecification

Definition at line 52 of file CategoryMembershipChangeJob.php.

References Job\$title, and Title\getArticleID().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\doUpdates().

◆ notifyUpdatesForRevision()

CategoryMembershipChangeJob::notifyUpdatesForRevision ( LBFactory  $lbFactory,
WikiPage  $page,
RevisionRecord  $newRev 
)
protected

◆ run()

CategoryMembershipChangeJob::run ( )

Member Data Documentation

◆ $ticket

int null CategoryMembershipChangeJob::$ticket
private

Definition at line 43 of file CategoryMembershipChangeJob.php.

◆ ENQUEUE_FUDGE_SEC

const CategoryMembershipChangeJob::ENQUEUE_FUDGE_SEC = 60
private

Definition at line 45 of file CategoryMembershipChangeJob.php.

Referenced by run().


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