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

Inheritance diagram for CategoryMembershipChangeJob:

[legend]

Collaboration diagram for CategoryMembershipChangeJob:

[legend]

Public Member Functions

__construct (Title $title, array $params)

Constructor for use by the Job Queue infrastructure.

getDeduplicationInfo ()

Subclasses may need to override this to make duplication detection work.

run ()

Run the job.

Public Member Functions inherited from Job

__construct ( $command, $params=null)

Stable to call.

allowRetries ()

Returns: bool Whether this job can be retried on failure by job runners

Since: 1.21

Stable to override

getLastError ()

Returns: string

Stable to override

getMetadata ( $field=null)

Stable to override.

getParams ()

Returns: array Parameters that specify sources, targets, and options for execution

Stable to override

getQueuedTimestamp ()

getReadyTimestamp ()

Returns: int|null UNIX timestamp of when the job was runnable, or null

Since: 1.26

Stable to override

getReleaseTimestamp ()

Stable to override.

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

getRootJobParams ()

Stable to override.

getTitle ()

getType ()

Returns: string Job type that defines what sort of changes this job makes

Stable to override

hasExecutionFlag ( $flag)

Parameters

int $flag JOB_* class constant

Returns: bool

Since: 1.31

Stable to override

hasRootJobParams ()

Stable to override.

ignoreDuplicates ()

Whether the queue should reject insertion of this job if a duplicate exists.

isRootJob ()

Stable to override.

setMetadata ( $field, $value)

Stable to override.

teardown ( $status)

Stable to override

toString ()

Returns: string Debugging string describing the job

Stable to override

workItemCount ()

Stable to override.

Public Member Functions inherited from RunnableJob

tearDown ( $status)

Do any final cleanup after run(), deferred updates, and all DB commits happen.

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.

static	newRootJobParams ( $key)
	Get "root job" parameters for a task.

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.

array	$params
	Array of job parameters.

Protected Attributes inherited from Job
string	$error
	Text for error that occurred last.

int	$executionFlags = 0
	Bitfield of JOB_* class constants.

bool	$removeDuplicates = false
	Expensive jobs may set this to true.

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	$title	Title of the categorized page.
array	$params	Such latest revision instance of the categorized page.

Definition at line 73 of file CategoryMembershipChangeJob.php.

References $title.

Member Function Documentation

◆ getCategoriesAtRev()

CategoryMembershipChangeJob::getCategoriesAtRev	(	WikiPage	$page,
		RevisionRecord	$rev,
			$parseTimestamp
	)

private

Parameters

WikiPage	$page
RevisionRecord	$rev
string	$parseTimestamp	TS_MW

Returns: string[] category names

Definition at line 264 of file CategoryMembershipChangeJob.php.

References MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\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

Definition at line 235 of file CategoryMembershipChangeJob.php.

References getCategoriesAtRev(), and MediaWiki\Revision\RevisionRecord\getTimestamp().

Referenced by notifyUpdatesForRevision().

◆ newSpec()

static CategoryMembershipChangeJob::newSpec	(	Title	$title,
			$revisionTimestamp
	)

static

Parameters

Title	$title	The title of the page for which to update category membership.
string	$revisionTimestamp	The timestamp of the new revision that triggered the job.