MediaWiki master
|
Job to add recent change entries mentioning category membership changes. More...
Inherits Job.
Public Member Functions | ||||
__construct (PageIdentity $page, 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. | ||||
![]() | ||||
__construct ( $command, $params=null) | ||||
allowRetries () | ||||
Whether to retry execution of this job if run() returned false or threw an exception.
| ||||
getLastError () | ||||
| ||||
getMetadata ( $field=null) | ||||
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. | ||||
isRootJob () | ||||
setMetadata ( $field, $value) | ||||
teardown ( $status) | ||||
toString () | ||||
| ||||
workItemCount () | ||||
![]() | ||||
tearDown ( $status) | ||||
Do any final cleanup after run(), deferred updates, and all DB commits happen. | ||||
Static Public Member Functions | |
static | newSpec (PageIdentity $page, $revisionTimestamp, bool $forImport) |
![]() | |
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) | |
![]() | |
addTeardownCallback ( $callback) | |
setLastError ( $error) | |
Additional Inherited Members | |
![]() | |
string | $command |
array | $metadata = [] |
Additional queue metadata. | |
array | $params |
Array of job parameters. | |
![]() | |
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 |
Job to add recent change entries mentioning category membership changes.
This allows users to easily scan categories for recent page membership changes
Parameters include:
Category changes will be mentioned for revisions at/after the timestamp for this page
Definition at line 46 of file CategoryMembershipChangeJob.php.
CategoryMembershipChangeJob::__construct | ( | PageIdentity | $page, |
array | $params ) |
Constructor for use by the Job Queue infrastructure.
PageIdentity | $page | the categorized page. |
array | $params | Such latest revision instance of the categorized page. |
Definition at line 80 of file CategoryMembershipChangeJob.php.
References $params.
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.
Reimplemented from Job.
Definition at line 284 of file CategoryMembershipChangeJob.php.
|
static |
PageIdentity | $page | the page for which to update category membership. |
string | $revisionTimestamp | The timestamp of the new revision that triggered the job. |
bool | $forImport | Whether the new revision that triggered the import was imported |
Definition at line 58 of file CategoryMembershipChangeJob.php.
References MediaWiki\Page\PageIdentity\getId().
|
protected |
LBFactory | $lbFactory | |
WikiPage | $page | |
RevisionRecord | $newRev |
Definition at line 181 of file CategoryMembershipChangeJob.php.
References Job\$title, Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication(), MediaWiki\Revision\RevisionRecord\getParentId(), WikiPage\getTitle(), MediaWiki\Revision\RevisionRecord\isDeleted(), and NS_CATEGORY.
Referenced by run().
CategoryMembershipChangeJob::run | ( | ) |
Run the job.
If this method returns false
or completes exceptionally, the job runner will retry executing this job unless the number of retries has exceeded its configured retry limit. Retries are allowed by default, unless allowRetries() is overridden to disable retries.
See the architecture doc for more information.
false
to instruct the job runner to retry a failed job. Otherwise return true
to indicate that a job completed (i.e. succeeded, or failed in a way that's deterministic or redundant). Implements RunnableJob.
Definition at line 87 of file CategoryMembershipChangeJob.php.
References DB_PRIMARY, DB_REPLICA, notifyUpdatesForRevision(), setLastError(), and wfTimestamp().