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 $title, array $params)
	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.
	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.
	getLastError ()
	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.
	insert ()
	Insert a single job into the queue.
	isRootJob ()
	teardown ( $status)
	Do any final cleanup after run(), deferred updates, and all DB commits happen.
	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.
static	getFinalDestination ( $title)
	Get the final destination of a redirect.
Static Public Member Functions inherited from Job
static	batchInsert ( $jobs)
	Batch-insert a group of jobs into the queue.
static	factory ( $command, Title $title, $params=[])
	Create the appropriate object to handle a specific job.
static	newRootJobParams ( $key)
	Get "root job" parameters for a task.

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

Static Private Attributes
static User	$user

Additional Inherited Members
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
	Expensive jobs may set this to true.
callable[]	$teardownCallbacks = []
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	$title,
		array	$params
	)

Parameters

Title	$title
array	$params

Definition at line 47 of file DoubleRedirectJob.php.

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

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	$reason	The reason for the fix, see message "double-redirect-fixed-<reason>"
Title	$redirTitle	The title which has changed, redirects pointing to this title are fixed
bool	$destTitle	Not used

Definition at line 61 of file DoubleRedirectJob.php.

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

Referenced by MovePageForm\doSubmit().

getFinalDestination()

static DoubleRedirectJob::getFinalDestination (   $title )

static

Get the final destination of a redirect.

Parameters

Title

$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 185 of file DoubleRedirectJob.php.

References Job\$title, DB_MASTER, Title\getDBkey(), Title\getNamespace(), Title\getPrefixedDBkey(), Title\isExternal(), 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 240 of file DoubleRedirectJob.php.

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

Referenced by run().

run()

DoubleRedirectJob::run

(

)

Returns

bool

Reimplemented from Job.

Definition at line 97 of file DoubleRedirectJob.php.

References $article, $reason, $user, $wgUser, EDIT_INTERNAL, EDIT_SUPPRESS_RC, EDIT_UPDATE, MagicWord\get(), getFinalDestination(), getUser(), global, Job\setLastError(), title, wfDebug(), and wfMessage().

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 33 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 38 of file DoubleRedirectJob.php.

Referenced by fixRedirects().

$user

User DoubleRedirectJob::$user

staticprivate

Definition at line 41 of file DoubleRedirectJob.php.

Referenced by getUser(), and run().

---

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

• includes/jobqueue/jobs/DoubleRedirectJob.php