MediaWiki  master
DoubleRedirectJob Class Reference

Fix any double redirects after moving a page. More...

Inheritance diagram for DoubleRedirectJob:
Collaboration diagram for DoubleRedirectJob:

Public Member Functions

 __construct (PageReference $page, array $params)
 
 run ()
 
- 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...
 

Static Public Member Functions

static fixRedirects ( $reason, $redirTitle)
 Insert jobs into the job queue to fix redirects to the given title. More...
 
static getFinalDestination ( $title)
 Get the final destination of a redirect. More...
 
- 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...
 

Additional Inherited Members

- 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

Fix any double redirects after moving a page.

Definition at line 33 of file DoubleRedirectJob.php.

Constructor & Destructor Documentation

◆ __construct()

DoubleRedirectJob::__construct ( PageReference  $page,
array  $params 
)
Parameters
PageReference$page
array$paramsExpected to contain these elements:
  • 'redirTitle' => string The title that changed and should be fixed.
  • 'reason' => string Reason for the change, can be "move" or "maintenance". Used as a suffix for the message keys "double-redirect-fixed-move" and "double-redirect-fixed-maintenance". ]

Definition at line 58 of file DoubleRedirectJob.php.

References Job\$params, and Title\newFromText().

Member Function Documentation

◆ fixRedirects()

static DoubleRedirectJob::fixRedirects (   $reason,
  $redirTitle 
)
static

Insert jobs into the job queue to fix redirects to the given title.

Parameters
string$reasonThe reason for the fix, see message "double-redirect-fixed-<reason>"
LinkTarget$redirTitleThe title which has changed, redirects pointing to this title are fixed

Definition at line 70 of file DoubleRedirectJob.php.

References $res, Job\$title, DB_PRIMARY, Title\getDBkey(), Title\getNamespace(), Title\makeTitle(), and wfGetDB().

◆ getFinalDestination()

static DoubleRedirectJob::getFinalDestination (   $title)
static

Get the final destination of a redirect.

Parameters
LinkTarget$title
Returns
Title|bool The final Title after following all redirects, or false if the page is not a redirect or the redirect loops.

Definition at line 202 of file DoubleRedirectJob.php.

References Job\$title, DB_PRIMARY, Title\getDBkey(), Title\getNamespace(), Title\isExternal(), Title\makeTitle(), wfDebug(), and wfGetDB().

Referenced by run().

◆ run()

DoubleRedirectJob::run ( )

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