MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage Class Reference

A special page for marking revisions of pages for translation. More...

Inheritance diagram for MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage:

Public Member Functions
	__construct (LanguageNameUtils $languageNameUtils, LanguageFactory $languageFactory, TranslationUnitStoreFactory $translationUnitStoreFactory, TranslatablePageParser $translatablePageParser, LinkBatchFactory $linkBatchFactory, JobQueueGroup $jobQueueGroup, ILoadBalancer $loadBalancer, MessageIndex $messageIndex)
	doesWrites ()
	execute ( $parameters)
	listPages ()

Static Public Member Functions
static	loadPagesFromDB ()
	TODO: Move this function to SyncTranslatableBundleStatusMaintenanceScript once we start using the translatable_bundles table for fetching the translatabale pages.
static	buildPageArray (IResultWrapper $res)
	TODO: Move this function to SyncTranslatableBundleStatusMaintenanceScript once we start using the translatable_bundles table for fetching the translatabale pages.

Protected Member Functions
	getGroupName ()
	onActionMark (Title $title, int $revision)
	showGenericConfirmation (array $params)
	showUnlinkConfirmation (Title $target)
	unmarkPage (TranslatablePage $page, UserIdentity $user)
	markForTranslation (TranslatablePage $page, ParserOutput $parse, array $sections, bool $updateVersion, bool $transclusion)
	This function does the heavy duty of marking a page.
	handlePriorityLanguages (WebRequest $request, TranslatablePage $page)

Detailed Description

A special page for marking revisions of pages for translation.

This page is the main tool for translation administrators in the wiki. It will list all pages in their various states and provides actions that are suitable for given translatable page.

Author

Niklas Laxström

Siebrand Mazeland @license GPL-2.0-or-later

Definition at line 58 of file PageTranslationSpecialPage.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::__construct	(	LanguageNameUtils	$languageNameUtils,
		LanguageFactory	$languageFactory,
		TranslationUnitStoreFactory	$translationUnitStoreFactory,
		TranslatablePageParser	$translatablePageParser,
		LinkBatchFactory	$linkBatchFactory,
		JobQueueGroup	$jobQueueGroup,
		ILoadBalancer	$loadBalancer,
		MessageIndex	$messageIndex )

Definition at line 84 of file PageTranslationSpecialPage.php.

Member Function Documentation

buildPageArray()

static MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::buildPageArray ( IResultWrapper $res )

static

TODO: Move this function to SyncTranslatableBundleStatusMaintenanceScript once we start using the translatable_bundles table for fetching the translatabale pages.

Definition at line 487 of file PageTranslationSpecialPage.php.

doesWrites()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::doesWrites

(

)

Definition at line 105 of file PageTranslationSpecialPage.php.

execute()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::execute

(

$parameters

)

Definition at line 113 of file PageTranslationSpecialPage.php.

getGroupName()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::getGroupName ( )

protected

Definition at line 109 of file PageTranslationSpecialPage.php.

handlePriorityLanguages()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::handlePriorityLanguages ( WebRequest $request, TranslatablePage $page )

protected

Parameters

WebRequest	$request
TranslatablePage	$page

Returns

void

Definition at line 1213 of file PageTranslationSpecialPage.php.

listPages()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::listPages

(

)

Definition at line 559 of file PageTranslationSpecialPage.php.

loadPagesFromDB()

static MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::loadPagesFromDB ( )

static

TODO: Move this function to SyncTranslatableBundleStatusMaintenanceScript once we start using the translatable_bundles table for fetching the translatabale pages.

Definition at line 460 of file PageTranslationSpecialPage.php.

markForTranslation()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::markForTranslation ( TranslatablePage $page, ParserOutput $parse, array $sections, bool $updateVersion, bool $transclusion )

protected

This function does the heavy duty of marking a page.

• Updates the source page with section markers.
• Updates translate_sections table
• Updates revtags table
• Sets up renderjobs to update the translation pages
• Invalidates caches
• Adds interim cache for MessageIndex

Parameters

TranslatablePage	$page
ParserOutput	$parse
TranslationUnit[]	$sections
bool	$updateVersion
bool	$transclusion

Returns

array|bool

Definition at line 1098 of file PageTranslationSpecialPage.php.

onActionMark()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::onActionMark ( Title $title, int $revision )

protected

Definition at line 283 of file PageTranslationSpecialPage.php.

showGenericConfirmation()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::showGenericConfirmation ( array $params )

protected

Definition at line 398 of file PageTranslationSpecialPage.php.

showUnlinkConfirmation()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::showUnlinkConfirmation ( Title $target )

protected

Definition at line 424 of file PageTranslationSpecialPage.php.

unmarkPage()

MediaWiki\Extension\Translate\PageTranslation\PageTranslationSpecialPage::unmarkPage ( TranslatablePage $page, UserIdentity $user )

protected

Definition at line 445 of file PageTranslationSpecialPage.php.

---

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

• src/PageTranslation/PageTranslationSpecialPage.php