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. | |
| run () | |
| Run a replaceText job. | |
 Public Member Functions inherited from Job | |
| allowRetries () | |
| getDeduplicationInfo () | |
| Subclasses may need to override this to make duplication detection work. | |
| 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. | |
| isRootJob () | |
| setMetadata ( $field, $value) | |
| teardown ( $status) | |
| toString () | |
| workItemCount () | |
| Public Member Functions inherited from RunnableJob | |
| tearDown ( $status) | |
| Do any final cleanup after run(), deferred updates, and all DB commits happen. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Job | |
| static | factory ( $command, $params=[]) |
| Create the appropriate object to handle a specific job. | |
| static | newRootJobParams ( $key) |
| Get "root job" parameters for a task. | |
| Public Attributes inherited from Job | |
| string | $command |
| array | $metadata = [] |
| Additional queue metadata. | |
| array | $params |
| Array of job parameters. | |
| Protected Member Functions inherited from Job | |
| addTeardownCallback ( $callback) | |
| setLastError ( $error) | |
| Protected Attributes inherited from Job | |
| string | $error |
| Text for error that occurred last. | |
| int | $executionFlags = 0 |
| Bitfield of JOB_* class constants. | |
| bool | $removeDuplicates = false |
| Expensive jobs may set this to true. | |
| 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 = '' ) |
Constructor.
- Parameters
-
Title $title array | bool $params Cannot 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 | ( | ) |
Run a replaceText job.
- Returns
- bool success
Implements RunnableJob.
Definition at line 43 of file ReplaceTextJob.php.
References Job\addTeardownCallback(), CONTENT_MODEL_WIKITEXT, WatchAction\doWatch(), EDIT_FORCE_BOT, EDIT_MINOR, EDIT_SUPPRESS_RC, and ReplaceTextSearch\getReplacedTitle().
The documentation for this class was generated from the following file:
- extensions/ReplaceText/src/ReplaceTextJob.php
