MediaWiki  master
ClearUserWatchlistJob Class Reference

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

Inheritance diagram for ClearUserWatchlistJob:
Collaboration diagram for ClearUserWatchlistJob:

Public Member Functions

 __construct (array $params)
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 run ()
 Run the job. More...
 
- Public Member Functions inherited from Job
 __construct ( $command, $params=null)
 
 allowRetries ()
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 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. More...
 
 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. More...
 

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. More...
 
static newRootJobParams ( $key)
 Get "root job" parameters for a task. More...
 

Additional Inherited Members

- Public Attributes inherited from Job
string $command
 
array $metadata = []
 Additional queue metadata. More...
 
array $params
 Array of job parameters. More...
 
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 
 setLastError ( $error)
 
- Protected Attributes inherited from Job
string $error
 Text for error that occurred last. More...
 
int $executionFlags = 0
 Bitfield of JOB_* class constants. More...
 
bool $removeDuplicates = false
 Expensive jobs may set this to true. More...
 
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.

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

Implements IJobSpecification.

Definition at line 102 of file ClearUserWatchlistJob.php.

◆ newForUser()

static ClearUserWatchlistJob::newForUser ( UserIdentity  $user,
  $maxWatchlistId 
)
static
Parameters
UserIdentity$userUser to clear the watchlist for.
int$maxWatchlistIdThe maximum wl_id at the time the job was first created.
Returns
ClearUserWatchlistJob

Definition at line 32 of file ClearUserWatchlistJob.php.

References MediaWiki\User\UserIdentity\getId().

Referenced by WatchedItemStore\clearUserWatchedItemsUsingJobQueue().

◆ run()

ClearUserWatchlistJob::run ( )

Run the job.

Returns
bool Success

Implements RunnableJob.

Definition at line 36 of file ClearUserWatchlistJob.php.

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


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