MediaWiki  master
ActivityUpdateJob Class Reference

Job for updating user activity like "last viewed" timestamps. More...

Inheritance diagram for ActivityUpdateJob:
Collaboration diagram for ActivityUpdateJob:

Public Member Functions

 __construct (LinkTarget $title, array $params)
 
 run ()
 Run the job. More...
 
- Public Member Functions inherited from Job
 __construct ( $command, $params=null)
 Stable for calling. More...
 
 allowRetries ()
 
Returns
bool Whether this job can be retried on failure by job runners
Since
1.21
Stable for overriding More...
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 getLastError ()
 
Returns
string
Stable for overriding More...
 
 getMetadata ( $field=null)
 Stable for overriding. More...
 
 getParams ()
 
Returns
array Parameters that specify sources, targets, and options for execution
Stable for overriding More...
 
 getQueuedTimestamp ()
 
 getReadyTimestamp ()
 
Returns
int|null UNIX timestamp of when the job was runnable, or null
Since
1.26
Stable for overriding More...
 
 getReleaseTimestamp ()
 Stable for overriding. More...
 
 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 for overriding More...
 
 getRootJobParams ()
 Stable for overriding. More...
 
 getTitle ()
 
 getType ()
 
Returns
string Job type that defines what sort of changes this job makes
Stable for overriding More...
 
 hasExecutionFlag ( $flag)
 
Parameters
int$flagJOB_* class constant
Returns
bool
Since
1.31
Stable for overriding More...
 
 hasRootJobParams ()
 Stable for overriding. More...
 
 ignoreDuplicates ()
 Whether the queue should reject insertion of this job if a duplicate exists. More...
 
 isRootJob ()
 Stable for overriding. More...
 
 setMetadata ( $field, $value)
 Stable for overriding. More...
 
 teardown ( $status)
 Stable for overriding More...
 
 toString ()
 
Returns
string Debugging string describing the job
Stable for overriding More...
 
 workItemCount ()
 Stable for overriding. More...
 
- Public Member Functions inherited from RunnableJob
 tearDown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 

Protected Member Functions

 updateWatchlistNotification ()
 
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 
 setLastError ( $error)
 

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 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 updating user activity like "last viewed" timestamps.

Job parameters include:

  • type: one of (updateWatchlistNotification) [required]
  • userid: affected user ID [required]
  • notifTime: timestamp to set watchlist entries to [required]
  • curTime: UNIX timestamp of the event that triggered this job [required]
Since
1.26

Definition at line 36 of file ActivityUpdateJob.php.

Constructor & Destructor Documentation

◆ __construct()

ActivityUpdateJob::__construct ( LinkTarget  $title,
array  $params 
)

Definition at line 37 of file ActivityUpdateJob.php.

References Job\$params, Job\$title, and Title\newFromLinkTarget().

Member Function Documentation

◆ run()

ActivityUpdateJob::run ( )

Run the job.

Returns
bool Success

Implements RunnableJob.

Definition at line 51 of file ActivityUpdateJob.php.

References updateWatchlistNotification().

◆ updateWatchlistNotification()

ActivityUpdateJob::updateWatchlistNotification ( )
protected

Definition at line 61 of file ActivityUpdateJob.php.

References DB_MASTER, and wfGetDB().

Referenced by run().


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