MediaWiki  master
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...

Inheritance diagram for ClearWatchlistNotificationsJob:
Collaboration diagram for ClearWatchlistNotificationsJob:

Public Member Functions

 __construct (array $params)
 
 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)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 
 toString ()
 
 workItemCount ()
 

Additional Inherited Members

- 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...
 
- 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 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 36 of file ClearWatchlistNotificationsJob.php.

Constructor & Destructor Documentation

◆ __construct()

ClearWatchlistNotificationsJob::__construct ( array  $params)
Parameters
array$paramsJSON-serializable map of parameters

Implements GenericParameterJob.

Definition at line 37 of file ClearWatchlistNotificationsJob.php.

Member Function Documentation

◆ run()

ClearWatchlistNotificationsJob::run ( )

Run the job.

Returns
bool Success

Implements RunnableJob.

Definition at line 49 of file ClearWatchlistNotificationsJob.php.

References $services, DB_MASTER, and null.


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