MediaWiki  1.33.0
ReplaceTextJob Class Reference

Background job to replace text in a given page. More...

Inheritance diagram for ReplaceTextJob:
Collaboration diagram for ReplaceTextJob:

Public Member Functions

 __construct ( $title, $params='')
 Constructor. More...
 run ()
 Run a replaceText job. More...
- Public Member Functions inherited from Job
 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

Background job to replace text in a given page.

  • based on /includes/RefreshLinksJob.php

Definition at line 29 of file ReplaceTextJob.php.

Constructor & Destructor Documentation

◆ __construct()

ReplaceTextJob::__construct (   $title,
  $params = '' 


array | bool$paramsCannot be === true

Reimplemented from Job.

Definition at line 35 of file ReplaceTextJob.php.

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

Member Function Documentation

◆ run()

ReplaceTextJob::run ( )

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