MediaWiki master
|
Job for clearing all of the "last viewed" timestamps for a user's watchlist, or setting them all to the same value. More...
Inherits Job, and GenericParameterJob.
Public Member Functions | ||||
__construct (array $params) | ||||
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.
| ||||
getDeduplicationInfo () | ||||
Subclasses may need to override this to make duplication detection work. | ||||
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. | ||||
Additional Inherited Members | |
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. | |
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 for clearing all of the "last viewed" timestamps for a user's watchlist, or setting them all to the same value.
Job parameters include:
Definition at line 41 of file ClearWatchlistNotificationsJob.php.
MediaWiki\Watchlist\ClearWatchlistNotificationsJob::__construct | ( | array | $params | ) |
array | $params | JSON-serializable map of parameters |
Implements GenericParameterJob.
Definition at line 42 of file ClearWatchlistNotificationsJob.php.
References Job\$params.
MediaWiki\Watchlist\ClearWatchlistNotificationsJob::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 54 of file ClearWatchlistNotificationsJob.php.
References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\MainConfigNames\UpdateRowsPerQuery.