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)
	run ()
Public Member Functions inherited from Job
	__construct ( $command, $params=null)
	Stable to call.
	allowRetries ()
	Returns bool Whether this job can be retried on failure by job runners Since 1.21 Stable to override
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.
	getLastError ()
	Returns string Stable to override
	getMetadata ( $field=null)
	Stable to override.
	getParams ()
	Returns array Parameters that specify sources, targets, and options for execution Stable to override
	getQueuedTimestamp ()
	getReadyTimestamp ()
	Returns int|null UNIX timestamp of when the job was runnable, or null Since 1.26 Stable to override
	getReleaseTimestamp ()
	Stable to override.
	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 Stable to override
	getRootJobParams ()
	Stable to override.
	getTitle ()
	getType ()
	Returns string Job type that defines what sort of changes this job makes Stable to override
	hasExecutionFlag ( $flag)
	Parameters int $flag JOB_* class constant Returns bool Since 1.31 Stable to override
	hasRootJobParams ()
	Stable to override.
	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists.
	isRootJob ()
	Stable to override.
	setMetadata ( $field, $value)
	Stable to override.
	teardown ( $status)
	Stable to override
	toString ()
	Returns string Debugging string describing the job Stable to override
	workItemCount ()
	Stable to override.
Public Member Functions inherited from RunnableJob
	tearDown ( $status)
	Do any final cleanup after run(), deferred updates, and all DB commits happen.

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	factory ( $command, $params=[])
	Create the appropriate object to handle a specific job.
static	newRootJobParams ( $key)
	Get "root job" parameters for a task.

Private Member Functions
	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.

Private Attributes
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 = false
	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 33 of file DoubleRedirectJob.php.

Constructor & Destructor Documentation

__construct()

DoubleRedirectJob::__construct	(	Title	$title,
		array	$params
	)

Parameters

Title	$title
array	$params	Expected 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 52 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 65 of file DoubleRedirectJob.php.

References $redirTitle, $res, Job\$title, DB_MASTER, Title\getDBkey(), Title\getNamespace(), Title\getPrefixedDBkey(), 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 191 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 ( )

private

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

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

Referenced by run().

run()

DoubleRedirectJob::run

(

)

Returns

bool

Implements RunnableJob.

Definition at line 101 of file DoubleRedirectJob.php.

References $content, $user, EDIT_INTERNAL, EDIT_SUPPRESS_RC, EDIT_UPDATE, getFinalDestination(), getUser(), Job\setLastError(), wfDebug(), and wfMessage().

Member Data Documentation

$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