MediaWiki master
|
Job to clear a users watchlist in batches. More...
Inherits Job, and GenericParameterJob.
Public Member Functions | ||||
__construct (array $params) | ||||
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) | ||||
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 () | ||||
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 | newForUser (UserIdentity $user, $maxWatchlistId) |
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. | |
Additional Inherited Members | |
Public Attributes inherited from Job | |
string | $command |
array | $metadata = [] |
Additional queue metadata. | |
array | $params |
Array of job parameters. | |
Protected Member Functions inherited from Job | |
addTeardownCallback ( $callback) | |
setLastError ( $error) | |
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 |
Job to clear a users watchlist in batches.
Definition at line 18 of file ClearUserWatchlistJob.php.
MediaWiki\Watchlist\ClearUserWatchlistJob::__construct | ( | array | $params | ) |
array | $params |
|
Implements GenericParameterJob.
Definition at line 24 of file ClearUserWatchlistJob.php.
References Job\$params.
MediaWiki\Watchlist\ClearUserWatchlistJob::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 109 of file ClearUserWatchlistJob.php.
|
static |
UserIdentity | $user | User to clear the watchlist for. |
int | $maxWatchlistId | The maximum wl_id at the time the job was first created. |
Definition at line 36 of file ClearUserWatchlistJob.php.
References MediaWiki\User\UserIdentity\getId().
MediaWiki\Watchlist\ClearUserWatchlistJob::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 40 of file ClearUserWatchlistJob.php.
References DB_PRIMARY, DB_REPLICA, MediaWiki\MediaWikiServices\getInstance(), Job\getParams(), Job\setLastError(), MediaWiki\MainConfigNames\UpdateRowsPerQuery, and MediaWiki\MainConfigNames\WatchlistExpiry.