MediaWiki  master
WatchlistExpiryJob Class Reference
Inheritance diagram for WatchlistExpiryJob:
Collaboration diagram for WatchlistExpiryJob:

Public Member Functions

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

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

Definition at line 5 of file WatchlistExpiryJob.php.

Constructor & Destructor Documentation

◆ __construct()

WatchlistExpiryJob::__construct ( string  $command = 'watchlistExpiry',
array  $params = [] 
)

Definition at line 7 of file WatchlistExpiryJob.php.

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

Member Function Documentation

◆ run()

WatchlistExpiryJob::run ( )

Run the job recursively in batches of 100 until there are no more expired items.

Returns
bool Always true, to indicate success.

Implements RunnableJob.

Definition at line 16 of file WatchlistExpiryJob.php.

References JobQueueGroup\singleton().


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