MediaWiki  REL1_31
ClearWatchlistNotificationsJob Class Reference

Job for clearing all of the "last viewed" timestamps for a user's watchlist. More...

Inheritance diagram for ClearWatchlistNotificationsJob:
Collaboration diagram for ClearWatchlistNotificationsJob:

Public Member Functions

 __construct (Title $title, array $params)
 
 run ()
 Run the job. More...
 
- Public Member Functions inherited from Job
 __construct ( $command, $title, $params=false)
 
 allowRetries ()
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 getLastError ()
 
 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...
 
 insert ()
 Insert a single job into the queue. More...
 
 isRootJob ()
 
 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 batchInsert ( $jobs)
 Batch-insert a group of jobs into the queue. More...
 
static factory ( $command, Title $title, $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
 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.

Job parameters include:

  • userId: affected user ID [required]
  • casTime: UNIX timestamp of the event that triggered this job [required]
Since
1.31

Definition at line 34 of file ClearWatchlistNotificationsJob.php.

Constructor & Destructor Documentation

◆ __construct()

ClearWatchlistNotificationsJob::__construct ( Title  $title,
array  $params 
)

Definition at line 35 of file ClearWatchlistNotificationsJob.php.

References Job\$params, and Job\$title.

Member Function Documentation

◆ run()

ClearWatchlistNotificationsJob::run ( )

Run the job.

Returns
bool Success

Reimplemented from Job.

Definition at line 47 of file ClearWatchlistNotificationsJob.php.

References $services, as, and DB_MASTER.


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