MediaWiki  1.23.2
DoubleRedirectJob Class Reference

Job to fix double redirects after moving a page. More...

Inheritance diagram for DoubleRedirectJob:
Collaboration diagram for DoubleRedirectJob:

Public Member Functions

 __construct ( $title, $params=false)
 
 getUser ()
 Get a user object for doing edits, from a request-lifetime cache False will be returned if the user name specified in the 'double-redirect-fixer' message is invalid. More...
 
 run ()
 
- Public Member Functions inherited from Job
 __construct ( $command, $title, $params=false)
 
 allowRetries ()
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 getLastError ()
 
 getParams ()
 
 getReleaseTimestamp ()
 
 getRootJobParams ()
 
 getTitle ()
 
 getType ()
 
 hasRootJobParams ()
 
 ignoreDuplicates ()
 
 insert ()
 Insert a single job into the queue. More...
 
 toString ()
 
 workItemCount ()
 

Static Public Member Functions

static fixRedirects ( $reason, $redirTitle, $destTitle=false)
 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 batchInsert ( $jobs)
 Batch-insert a group of jobs into the queue. More...
 
static factory ( $command, Title $title, $params=false)
 Create the appropriate object to handle a specific job. More...
 
static newRootJobParams ( $key)
 
static pop ()
 Pop a job off the front of the queue. More...
 
static pop_type ( $type)
 Pop a job of a certain type. More...
 
static safeBatchInsert ( $jobs)
 Insert a group of jobs into the queue. More...
 

Private Attributes

string $reason
 Reason for the change, 'maintenance' or 'move'. More...
 
Title $redirTitle
 The title which has changed, redirects pointing to this title are fixed. More...
 

Static Private Attributes

static $user
 

Additional Inherited Members

- Public Attributes inherited from Job
string $command
 
array $metadata = array()
 Additional queue metadata *. More...
 
array bool $params
 Array of job parameters or false if none *. More...
 
- Protected Member Functions inherited from Job
 setLastError ( $error)
 
- Protected Attributes inherited from Job
string $error
 Text for error that occurred last *. More...
 
bool $removeDuplicates
 Expensive jobs may set this to true *. More...
 
Title $title
 

Detailed Description

Job to fix double redirects after moving a page.

Definition at line 29 of file DoubleRedirectJob.php.

Constructor & Destructor Documentation

◆ __construct()

DoubleRedirectJob::__construct (   $title,
  $params = false 
)
Parameters
Title$title
array | bool$params
int$id

Definition at line 87 of file DoubleRedirectJob.php.

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

Member Function Documentation

◆ fixRedirects()

static DoubleRedirectJob::fixRedirects (   $reason,
  $redirTitle,
  $destTitle = false 
)
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>"
$redirTitleTitle: the title which has changed, redirects pointing to this title are fixed
bool$destTitleNot used

Definition at line 49 of file DoubleRedirectJob.php.

References $reason, $redirTitle, $res, Job\$title, array(), as, DB_MASTER, Title\getDBkey(), Title\getNamespace(), Title\getPrefixedDBkey(), Title\makeTitle(), JobQueueGroup\singleton(), and wfGetDB().

Referenced by MovePageForm\doSubmit().

◆ getFinalDestination()

static DoubleRedirectJob::getFinalDestination (   $title)
static

Get the final destination of a redirect.

Parameters
$titleTitle
Returns
bool if the specified title is not a redirect, or if it is a circular redirect

Definition at line 182 of file DoubleRedirectJob.php.

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

Referenced by run().

◆ getUser()

DoubleRedirectJob::getUser ( )

Get a user object for doing edits, from a request-lifetime cache False will be returned if the user name specified in the 'double-redirect-fixer' message is invalid.

Returns
User|bool

Definition at line 237 of file DoubleRedirectJob.php.

References $user, $user, User\newFromName(), and wfMessage().

Referenced by run().

◆ run()

Member Data Documentation

◆ $reason

string DoubleRedirectJob::$reason
private

Reason for the change, 'maintenance' or 'move'.

Suffix fo message key 'double-redirect-fixed-'.

Definition at line 32 of file DoubleRedirectJob.php.

Referenced by fixRedirects(), and run().

◆ $redirTitle

Title DoubleRedirectJob::$redirTitle
private

The title which has changed, redirects pointing to this title are fixed.

Definition at line 36 of file DoubleRedirectJob.php.

Referenced by fixRedirects().

◆ $user

DoubleRedirectJob::$user
staticprivate

Definition at line 39 of file DoubleRedirectJob.php.

Referenced by getUser(), and run().


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