MediaWiki\Watchlist\ClearWatchlistNotificationsJob Class Reference

Job for clearing all of the "last viewed" timestamps for a user's watchlist, or setting them all to the same value. More...

Inherits MediaWiki\JobQueue\Job, and MediaWiki\JobQueue\GenericParameterJob.

Collaboration diagram for MediaWiki\Watchlist\ClearWatchlistNotificationsJob:

Public Member Functions
	__construct (array $params)
	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. Returns bool Return 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).
Public Member Functions inherited from MediaWiki\JobQueue\Job
	__construct ( $command, $params=null)
	allowRetries ()
	Whether to retry execution of this job if run() returned false or threw an exception. Warning In some setups (i.e. when using change-propagation) jobs may still be retried even when this is false if the job fails due to a timeout unless it is also configured in change-prop config (T358939). Returns bool Whether this job can be retried on failure by job runners Since 1.21
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.
	getLastError ()
	Returns string
	getMetadata ( $field=null)
	getParams ()
	Returns array Parameters that specify sources, targets, and options for execution
	getQueuedTimestamp ()
	getReadyTimestamp ()
	Returns int|null UNIX timestamp of when the job was runnable, or null Since 1.26
	getReleaseTimestamp ()
	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
	getRootJobParams ()
	getTitle ()
	getType ()
	Returns string Job type that defines what sort of changes this job makes
	hasExecutionFlag ( $flag)
	Parameters int $flag JOB_* class constant Returns bool Since 1.31
	hasRootJobParams ()
	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists.
	isRootJob ()
	setMetadata ( $field, $value)
	teardown ( $status)
	toString ()
	Returns string Debugging string describing the job
	workItemCount ()
Public Member Functions inherited from MediaWiki\JobQueue\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 MediaWiki\JobQueue\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 MediaWiki\JobQueue\Job
string	$command
array	$metadata = []
	Additional queue metadata.
array	$params
	Array of job parameters.
Protected Member Functions inherited from MediaWiki\JobQueue\Job
	addTeardownCallback ( $callback)
	setLastError ( $error)
Protected Attributes inherited from MediaWiki\JobQueue\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 for clearing all of the "last viewed" timestamps for a user's watchlist, or setting them all to the same value.

Job parameters include:

• userId: affected user ID [required]
• casTime: UNIX timestamp of the event that triggered this job [required]
• timestamp: value to set all of the "last viewed" timestamps to [optional, defaults to null]

Since

1.31

Definition at line 27 of file ClearWatchlistNotificationsJob.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Watchlist\ClearWatchlistNotificationsJob::__construct

(

array

$params

)

Parameters

array

$params

JSON-serializable map of parameters

Implements MediaWiki\JobQueue\GenericParameterJob.

Definition at line 28 of file ClearWatchlistNotificationsJob.php.

References MediaWiki\JobQueue\Job\$params.

Member Function Documentation

run()

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.

Returns

bool Return 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 MediaWiki\JobQueue\RunnableJob.

Definition at line 41 of file ClearWatchlistNotificationsJob.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\MainConfigNames\UpdateRowsPerQuery.

---

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

• includes/Watchlist/ClearWatchlistNotificationsJob.php