DoubleRedirectJob Class Reference

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

Inherits Job.

Collaboration diagram for DoubleRedirectJob:

Public Member Functions
	__construct (PageReference $page, array $params, RevisionLookup $revisionLookup, MagicWordFactory $magicWordFactory, WikiPageFactory $wikiPageFactory)
	run ()
Public Member Functions inherited from Job
	__construct ( $command, $params=null)
	allowRetries ()
	Warning In some setups (i.e. when using change-propagation) jobs may still be retried even when this is false if the job fails due to a timeout unless it is also configured in change-prop config (T358939). Returns bool Whether this job can be retried on failure by job runners Since 1.21
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.
	getLastError ()
	Returns string
	getMetadata ( $field=null)
	getParams ()
	Returns array Parameters that specify sources, targets, and options for execution
	getQueuedTimestamp ()
	getReadyTimestamp ()
	Returns int|null UNIX timestamp of when the job was runnable, or null Since 1.26
	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
	getRootJobParams ()
	getTitle ()
	getType ()
	Returns string Job type that defines what sort of changes this job makes
	hasExecutionFlag ( $flag)
	Parameters int $flag JOB_* class constant Returns bool Since 1.31
	hasRootJobParams ()
	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists.
	isRootJob ()
	setMetadata ( $field, $value)
	teardown ( $status)
	toString ()
	Returns string Debugging string describing the job
	workItemCount ()
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)
	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.

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

Fix any double redirects after moving a page.

Definition at line 37 of file DoubleRedirectJob.php.

Constructor & Destructor Documentation

__construct()

DoubleRedirectJob::__construct	(	PageReference	$page,
		array	$params,
		RevisionLookup	$revisionLookup,
		MagicWordFactory	$magicWordFactory,
		WikiPageFactory	$wikiPageFactory )

Parameters

PageReference	$page
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". ]
RevisionLookup	$revisionLookup
MagicWordFactory	$magicWordFactory
WikiPageFactory	$wikiPageFactory

Definition at line 74 of file DoubleRedirectJob.php.

References $params.

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

Definition at line 95 of file DoubleRedirectJob.php.

References Job\$title, MediaWiki\Title\Title\canExist(), MediaWiki\Title\Title\getDBkey(), and MediaWiki\Title\Title\getNamespace().

getFinalDestination()

static DoubleRedirectJob::getFinalDestination ( $title )

static

Get the final destination of a redirect.

Parameters

LinkTarget

$title

Returns

Title|false The final Title after following all redirects, or false if the page is not a redirect or the redirect loops.

Definition at line 238 of file DoubleRedirectJob.php.

References Job\$title, MediaWiki\Title\Title\getDBkey(), MediaWiki\Title\Title\getNamespace(), MediaWiki\Linker\LinkTarget\isExternal(), and wfDebug().

run()

DoubleRedirectJob::run

(

)

Returns

bool

Implements RunnableJob.

Definition at line 140 of file DoubleRedirectJob.php.

References $wgUser, EDIT_INTERNAL, EDIT_MINOR, EDIT_SUPPRESS_RC, EDIT_UPDATE, getUser(), setLastError(), wfDebug(), and wfMessage().

---

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

• includes/jobqueue/jobs/DoubleRedirectJob.php