Resolves the mw:I18n and mw:LocalizedAttrs to their localised forms. More...

Inherits MediaWiki\OutputTransform\ContentDOMTransformStage.

Collaboration diagram for MediaWiki\OutputTransform\Stages\ParsoidLocalization:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, LoggerInterface $logger, private LanguageFactory $languageFactory)

	shouldRun (ParserOutput $po, ParserOptions $popts, array $options=[])
	Decides whether or not the stage should be run.

	transformDOM (DocumentFragment $df, ParserOutput $po, ParserOptions $popts, array &$options)
	Applies the transformation to a DOM document.

Public Member Functions inherited from MediaWiki\OutputTransform\ContentDOMTransformStage
	__construct (ServiceOptions $options, LoggerInterface $logger, private readonly bool $transformBodyOnly,)

	createElement (Document $doc, string $name, array $attribs=[], Node\|string ... $children)
	Helper method for DOM transforms to easily create DOM Elements with the given attributes and children.

	transform (ParserOutput $po, ParserOptions $popts, array &$options)
	Transforms the input ParserOutput into the returned ParserOutput.The returned ParserOutput can explicitly be a modified version of the input ParserOutput; if modifications to that object are unexpected, a copy should be made before passing it to this method. TODO Some transformations require the possibility of modifying options (this is the case of ExecutePostCacheTransformHooks in particular). We do NOT want to keep this mechanism for later versions of this interface - the currently foreseen goal is to not pass $options at all. Modifying $options during this pass is considered deprecated. Stability: unstable

Public Member Functions inherited from MediaWiki\OutputTransform\OutputTransformStage
	__construct (ServiceOptions $options, LoggerInterface $logger,)

Static Public Attributes
static bool	$bodyOnly = false

Additional Inherited Members
Public Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage
const	CONSTRUCTOR_OPTIONS = []

Protected Member Functions inherited from MediaWiki\OutputTransform\ContentDOMTransformStage
	getFragmentsToTransform (ParserOutput $po, ParserOptions $popts)
	Override this method if you need more control over which fragments should be transformed.

Protected Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage
LoggerInterface	$logger

ServiceOptions	$options

Detailed Description

Resolves the mw:I18n and mw:LocalizedAttrs to their localised forms.

Access: internal

Definition at line 31 of file ParsoidLocalization.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\OutputTransform\Stages\ParsoidLocalization::__construct	(	ServiceOptions	$options,
		LoggerInterface	$logger,
		private LanguageFactory	$languageFactory )

Definition at line 34 of file ParsoidLocalization.php.

References MediaWiki\OutputTransform\OutputTransformStage\$logger, and MediaWiki\OutputTransform\OutputTransformStage\$options.

Member Function Documentation

◆ shouldRun()

MediaWiki\OutputTransform\Stages\ParsoidLocalization::shouldRun	(	ParserOutput	$po,
		ParserOptions	$popts,
		array	$options = [] )

Decides whether or not the stage should be run.

Parameters

ParserOutput $po

Stability: unstable

Parameters

ParserOptions	$popts
array	$options

Returns: bool

Reimplemented from MediaWiki\OutputTransform\OutputTransformStage.

Definition at line 42 of file ParsoidLocalization.php.

◆ transformDOM()

MediaWiki\OutputTransform\Stages\ParsoidLocalization::transformDOM	(	DocumentFragment	$df,
		ParserOutput	$po,
		ParserOptions	$popts,
		array &	$options )

Applies the transformation to a DOM document.

Reimplemented from MediaWiki\OutputTransform\ContentDOMTransformStage.

Definition at line 46 of file ParsoidLocalization.php.

Member Data Documentation

◆ $bodyOnly

bool MediaWiki\OutputTransform\Stages\ParsoidLocalization::$bodyOnly = false

static

Definition at line 32 of file ParsoidLocalization.php.

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

includes/OutputTransform/Stages/ParsoidLocalization.php

Public Member Functions

Static Public Attributes

Additional Inherited Members