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

Inheritance diagram for ClearUserWatchlistJob:

[legend]

Collaboration diagram for ClearUserWatchlistJob:

[legend]

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)

Stable to call.

allowRetries ()

Returns: bool Whether this job can be retried on failure by job runners

Since: 1.21

Stable to override

getLastError ()

Returns: string

Stable to override

getMetadata ( $field=null)

Stable to override.

getParams ()

Returns: array Parameters that specify sources, targets, and options for execution

Stable to override

getQueuedTimestamp ()

getReadyTimestamp ()

Returns: int|null UNIX timestamp of when the job was runnable, or null

Since: 1.26

Stable to override

getReleaseTimestamp ()

Stable to override.

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

Stable to override

getRootJobParams ()

Stable to override.

getTitle ()

getType ()

Returns: string Job type that defines what sort of changes this job makes

Stable to override

hasExecutionFlag ( $flag)

Parameters

int $flag JOB_* class constant

Returns: bool

Since: 1.31

Stable to override

hasRootJobParams ()

Stable to override.

ignoreDuplicates ()

Whether the queue should reject insertion of this job if a duplicate exists.

isRootJob ()

Stable to override.

setMetadata ( $field, $value)

Stable to override.

teardown ( $status)

Stable to override

toString ()

Returns: string Debugging string describing the job

Stable to override

workItemCount ()

Stable to override.

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

Detailed Description

Job to clear a users watchlist in batches.

Author: Addshore

Since: 1.31

Definition at line 14 of file ClearUserWatchlistJob.php.

Constructor & Destructor Documentation

◆ __construct()

ClearUserWatchlistJob::__construct ( array $params )

Parameters

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,

Implements GenericParameterJob.

Definition at line 20 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.

Stable to override