Job to clear a users watchlist in batches. More...

Inheritance diagram for ClearUserWatchlistJob:

[legend]

Collaboration diagram for ClearUserWatchlistJob:

[legend]

Public Member Functions
	__construct (Title $title=null, 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 ()

	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)
	Do any final cleanup after run(), deferred updates, and all DB commits happen.

	toString ()

	workItemCount ()

Static Public Member Functions
static	newForUser (User $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

Detailed Description

Job to clear a users watchlist in batches.

Author: Addshore

Since: 1.31

Definition at line 13 of file ClearUserWatchlistJob.php.

Constructor & Destructor Documentation

◆ __construct()

ClearUserWatchlistJob::__construct	(	Title	$title = `null`,
		array	$params
	)

Parameters

Title \| null	$title	Not used by this job.
array	$params	userId, The ID for the user whose watchlist is being cleared. maxWatchlistId, The maximum wl_id at the time the job was first created,

Definition at line 34 of file ClearUserWatchlistJob.php.

References Job\$params.

Member Function Documentation

◆ getDeduplicationInfo()

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.

Returns: array Map of key/values

Since: 1.21

Reimplemented from Job.

Definition at line 110 of file ClearUserWatchlistJob.php.

◆ newForUser()

static ClearUserWatchlistJob::newForUser	(	User	$user,
			$maxWatchlistId
	)

static

Parameters

User	$user	User to clear the watchlist for.
int	$maxWatchlistId	The maximum wl_id at the time the job was first created.

Returns: ClearUserWatchlistJob

Definition at line 21 of file ClearUserWatchlistJob.php.

References $user.

Referenced by WatchedItemStore\clearUserWatchedItemsUsingJobQueue().

◆ run()

ClearUserWatchlistJob::run ( )

Run the job.

Returns: bool Success

Reimplemented from Job.

Definition at line 44 of file ClearUserWatchlistJob.php.

References $dbr, $wgUpdateRowsPerQuery, DB_MASTER, DB_REPLICA, Job\getParams(), Job\getTitle(), and Job\setLastError().

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

includes/jobqueue/jobs/ClearUserWatchlistJob.php

Public Member Functions

Static Public Member Functions