Mixed bag of methods related to translatable pages. More...

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

Public Member Functions
	getTitle ()
	@inheritDoc

	getPageIdentity ()

	getText ()
	Returns the text for this translatable page.

	getRevision ()
	Revision is null if object was constructed using newFromText.

	getSourceLanguageCode ()
	Returns the source language of this translatable page.

	getMessageGroupId ()
	@inheritDoc

	getMessageGroup ()
	Returns MessageGroup used for translating this page.

	hasPageDisplayTitle ()
	Check whether title is marked for translation.

	getPageDisplayTitle (string $languageCode)
	Get translated page title.

	getStrippedSourcePageText ()

	getTranslationPage (string $targetLanguage)

	addMarkedTag (int $revision, ?array $value=null)
	Adds a tag which indicates that this page is suitable for translation.

	addReadyTag (int $revision)
	Adds a tag which indicates that this page source is ready for marking for translation.

	getMarkedTag ()
	Returns the latest revision which has marked tag, if any.

	getReadyTag ()
	Returns the latest revision which has ready tag, if any.

	getTranslationUrl ( $code=false)
	Produces a link to translation view of a translation page.

	getTranslationPages ()
	@inheritDoc

	getTranslationUnitPages (?string $code=null)
	@inheritDoc

	getTranslationPercentages ()

	supportsTransclusion ()

	getRevisionRecordWithFallback ()

	isMoveable ()
	@inheritDoc

	isDeletable ()
	@inheritDoc

	isBroken ()

Static Public Member Functions
static	newFromText (PageIdentity $page, string $text)
	Constructs a translatable page from given text.

static	newFromRevision (PageIdentity $page, int $revision)
	Constructs a translatable page from given revision.

static	newFromTitle (PageIdentity $page)
	Constructs a translatable page from title.

static	getMessageGroupIdFromTitle (PageReference $page)
	Constructs MessageGroup id for any title.

static	getTranslationPageFromTitle (Title $title)

static	isTranslationPage (Title $title)

static	parseTranslationUnit (LinkTarget $translationUnit)
	Helper to guess translation page from translation unit.

static	isSourcePage (PageIdentity $page)

static	clearSourcePageCache ()
	Clears the source page cache.

static	determineStatus (?int $readyRevisionId, ?int $markRevisionId, int $latestRevisionId)

static	getCacheValue ( $oldValue, &$ttl, array &$setOpts)
	Get list of translatable page ids to be stored in the cache.

Public Attributes
const	METADATA_KEYS
	List of keys in the metadata table that need to be handled for moves and deletions @phpcs-require-sorted-array.

const	DISPLAY_TITLE_UNIT_ID = 'Page display title'

Protected Member Functions
	__construct (private readonly PageIdentity $page,)

Protected Member Functions inherited from MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle
	getTranslationUnitPagesByTitle (PageReference $title, ?string $code=null)

Protected Attributes
RevTagStore	$revTagStore

	$text

	$revision

	$source

	$pageDisplayTitle

Detailed Description

Mixed bag of methods related to translatable pages.

Author: Niklas Laxström @license GPL-2.0-or-later

Definition at line 35 of file TranslatablePage.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::__construct ( private readonly PageIdentity $page )

protected

Definition at line 63 of file TranslatablePage.php.

Member Function Documentation

◆ addMarkedTag()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::addMarkedTag	(	int	$revision,
		?array	$value = null )

Adds a tag which indicates that this page is suitable for translation.

Definition at line 276 of file TranslatablePage.php.

◆ addReadyTag()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::addReadyTag ( int $revision )

Adds a tag which indicates that this page source is ready for marking for translation.

Definition at line 282 of file TranslatablePage.php.

◆ clearSourcePageCache()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::clearSourcePageCache ( )

static

Clears the source page cache.

Definition at line 503 of file TranslatablePage.php.

◆ determineStatus()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::determineStatus	(	?int	$readyRevisionId,
		?int	$markRevisionId,
		int	$latestRevisionId )

static

Definition at line 508 of file TranslatablePage.php.

◆ getCacheValue()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getCacheValue	(		$oldValue,
		&	$ttl,
		array &	$setOpts )

static

Get list of translatable page ids to be stored in the cache.

Definition at line 545 of file TranslatablePage.php.

◆ getMarkedTag()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getMarkedTag ( )

Returns the latest revision which has marked tag, if any.

Definition at line 290 of file TranslatablePage.php.

◆ getMessageGroup()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getMessageGroup ( )

Returns MessageGroup used for translating this page.

It may still be empty if the page has not been ever marked.

Definition at line 187 of file TranslatablePage.php.

◆ getMessageGroupId()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getMessageGroupId ( )

@inheritDoc

Reimplemented from MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle.

Definition at line 174 of file TranslatablePage.php.

◆ getMessageGroupIdFromTitle()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getMessageGroupIdFromTitle ( PageReference $page )

static

Constructs MessageGroup id for any title.

Definition at line 179 of file TranslatablePage.php.

◆ getPageDisplayTitle()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getPageDisplayTitle ( string $languageCode )

Get translated page title.

Definition at line 216 of file TranslatablePage.php.

◆ getPageIdentity()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getPageIdentity ( )

Definition at line 118 of file TranslatablePage.php.

◆ getReadyTag()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getReadyTag ( )

Returns the latest revision which has ready tag, if any.

Definition at line 295 of file TranslatablePage.php.

◆ getRevision()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getRevision ( )

Revision is null if object was constructed using newFromText.

Returns: null|int

Definition at line 160 of file TranslatablePage.php.

◆ getRevisionRecordWithFallback()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getRevisionRecordWithFallback ( )

Definition at line 396 of file TranslatablePage.php.

◆ getSourceLanguageCode()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getSourceLanguageCode ( )

Returns the source language of this translatable page.

In other words the language in which the page without language code is written.

Since: 2013-01-28

Definition at line 169 of file TranslatablePage.php.

◆ getStrippedSourcePageText()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getStrippedSourcePageText ( )

Definition at line 240 of file TranslatablePage.php.

◆ getText()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getText ( )

Returns the text for this translatable page.

Definition at line 123 of file TranslatablePage.php.

◆ getTitle()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getTitle ( )

@inheritDoc

Reimplemented from MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle.

Definition at line 114 of file TranslatablePage.php.

◆ getTranslationPage()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getTranslationPage ( string $targetLanguage )

Definition at line 253 of file TranslatablePage.php.

◆ getTranslationPageFromTitle()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getTranslationPageFromTitle ( Title $title )

static

Definition at line 248 of file TranslatablePage.php.

◆ getTranslationPages()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getTranslationPages ( )

@inheritDoc

Reimplemented from MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle.

Definition at line 318 of file TranslatablePage.php.

◆ getTranslationPercentages()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getTranslationPercentages ( )

Definition at line 348 of file TranslatablePage.php.

◆ getTranslationUnitPages()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getTranslationUnitPages ( ?string $code = null )

@inheritDoc

Reimplemented from MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle.

Definition at line 344 of file TranslatablePage.php.

◆ getTranslationUrl()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::getTranslationUrl ( $code = false )

Produces a link to translation view of a translation page.

Parameters

string | bool $code MediaWiki language code. Default: false.

Returns: string Relative url

Definition at line 304 of file TranslatablePage.php.

◆ hasPageDisplayTitle()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::hasPageDisplayTitle ( )

Check whether title is marked for translation.

Definition at line 201 of file TranslatablePage.php.

◆ isBroken()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::isBroken ( )

Definition at line 495 of file TranslatablePage.php.

◆ isDeletable()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::isDeletable ( )

@inheritDoc

Reimplemented from MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle.

Definition at line 414 of file TranslatablePage.php.

◆ isMoveable()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::isMoveable ( )

@inheritDoc

Reimplemented from MediaWiki\Extension\Translate\MessageGroupProcessing\TranslatableBundle.

Definition at line 409 of file TranslatablePage.php.

◆ isSourcePage()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::isSourcePage ( PageIdentity $page )

static

Definition at line 457 of file TranslatablePage.php.

◆ isTranslationPage()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::isTranslationPage ( Title $title )

static

Returns: bool|self

Definition at line 419 of file TranslatablePage.php.

◆ newFromRevision()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::newFromRevision	(	PageIdentity	$page,
		int	$revision )

static

Constructs a translatable page from given revision.

The revision must belong to the title given or unspecified behavior will happen.

Definition at line 87 of file TranslatablePage.php.

◆ newFromText()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::newFromText	(	PageIdentity	$page,
		string	$text )

static

Constructs a translatable page from given text.

Some functions will fail unless you set revision parameter manually.

Definition at line 74 of file TranslatablePage.php.

◆ newFromTitle()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::newFromTitle ( PageIdentity $page )

static

Constructs a translatable page from title.

The text of last marked revision is loaded when needed.

Definition at line 106 of file TranslatablePage.php.

◆ parseTranslationUnit()

static MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::parseTranslationUnit ( LinkTarget $translationUnit )

static

Helper to guess translation page from translation unit.

Definition at line 440 of file TranslatablePage.php.

◆ supportsTransclusion()

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::supportsTransclusion ( )

Definition at line 385 of file TranslatablePage.php.

Member Data Documentation

◆ $pageDisplayTitle

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::$pageDisplayTitle

protected

Definition at line 59 of file TranslatablePage.php.

◆ $revision

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::$revision

protected

Definition at line 55 of file TranslatablePage.php.

◆ $revTagStore

RevTagStore MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::$revTagStore

protected

Definition at line 51 of file TranslatablePage.php.

◆ $source

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::$source

protected

Definition at line 57 of file TranslatablePage.php.

◆ $text

MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::$text

protected

Definition at line 53 of file TranslatablePage.php.

◆ DISPLAY_TITLE_UNIT_ID

const MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::DISPLAY_TITLE_UNIT_ID = 'Page display title'

Definition at line 49 of file TranslatablePage.php.

◆ METADATA_KEYS

const MediaWiki\Extension\Translate\PageTranslation\TranslatablePage::METADATA_KEYS

Initial value:

= [
        'maxid',
        'priorityforce',
        'prioritylangs',
        'priorityreason',
        'transclusion',
        'version'
    ]

List of keys in the metadata table that need to be handled for moves and deletions @phpcs-require-sorted-array.

Definition at line 40 of file TranslatablePage.php.

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

src/PageTranslation/TranslatablePage.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMarkedTag()

◆ addReadyTag()

◆ clearSourcePageCache()

◆ determineStatus()

◆ getCacheValue()

◆ getMarkedTag()

◆ getMessageGroup()

◆ getMessageGroupId()

◆ getMessageGroupIdFromTitle()

◆ getPageDisplayTitle()

◆ getPageIdentity()

◆ getReadyTag()

◆ getRevision()

◆ getRevisionRecordWithFallback()

◆ getSourceLanguageCode()

◆ getStrippedSourcePageText()

◆ getText()

◆ getTitle()

◆ getTranslationPage()

◆ getTranslationPageFromTitle()

◆ getTranslationPages()

◆ getTranslationPercentages()

◆ getTranslationUnitPages()

◆ getTranslationUrl()

◆ hasPageDisplayTitle()

◆ isBroken()

◆ isDeletable()

◆ isMoveable()

◆ isSourcePage()

◆ isTranslationPage()

◆ newFromRevision()

◆ newFromText()

◆ newFromTitle()

◆ parseTranslationUnit()

◆ supportsTransclusion()

Member Data Documentation

◆ $pageDisplayTitle

◆ $revision

◆ $revTagStore

◆ $source

◆ $text

◆ DISPLAY_TITLE_UNIT_ID

◆ METADATA_KEYS