MediaWiki\OutputTransform\ContentHolderTransformStage Class Reference

OutputTransformStages that can modify the content either as a DOM tree or an HTML string. More...

Inherits MediaWiki\OutputTransform\OutputTransformStage.

Collaboration diagram for MediaWiki\OutputTransform\ContentHolderTransformStage:

Public Member Functions
	__construct (ServiceOptions $options, LoggerInterface $logger, private ContentTextTransformStage $textTransform, private ContentDOMTransformStage $domTransform, private bool $exclusive=false,)
	reset ()
	Reset the stage.
	shouldRun (ParserOutput $po, ParserOptions $popts, array $options=[])
	Decides whether or not the stage should be run.
	transform (ParserOutput $po, ParserOptions $popts, array &$options)
	Transforms the input ParserOutput into the returned ParserOutput.
Public Member Functions inherited from MediaWiki\OutputTransform\OutputTransformStage
	__construct (ServiceOptions $options, LoggerInterface $logger,)

Additional Inherited Members
Public Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage
const	CONSTRUCTOR_OPTIONS = []
Protected Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage
LoggerInterface	$logger
ServiceOptions	$options

Detailed Description

OutputTransformStages that can modify the content either as a DOM tree or an HTML string.

It contains both a ContentDOMTransformStage for the former, and a ContentTextTransformStage for the latter, and can be set up to either consider these interchangeable depending on what is useful, or to be exclusive if they do not provide the same function (e.g. passes that do not behave in the same way for Parsoid and Legacy could be defined as exclusive Parsoid-DOM and Legacy-Html).

Access: internal

Definition at line 22 of file ContentHolderTransformStage.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\OutputTransform\ContentHolderTransformStage::__construct	(	ServiceOptions	$options,
		LoggerInterface	$logger,
		private ContentTextTransformStage	$textTransform,
		private ContentDOMTransformStage	$domTransform,
		private bool	$exclusive = false )

Parameters

$textTransform	The HTML transform.
$domTransform	The DOM transform.
$exclusive	True if only one of $textTransform and $domTransform are expected to apply; false if both transforms are equivalent and either can be selected depending on the ContentHolder preferences.

Definition at line 23 of file ContentHolderTransformStage.php.

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

Member Function Documentation

reset()

MediaWiki\OutputTransform\ContentHolderTransformStage::reset

(

)

Reset the stage.

Some stages (e.g. DeduplicateStyles) benefit from keeping a state between the different fragments that they transform; but that state should still be reset between two invocations of the pipeline. This method is called on each stage at the beginning of OutputTransformPipeline::run to ensure that this is the case.

Reimplemented from MediaWiki\OutputTransform\OutputTransformStage.

Definition at line 60 of file ContentHolderTransformStage.php.

shouldRun()

MediaWiki\OutputTransform\ContentHolderTransformStage::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 40 of file ContentHolderTransformStage.php.

transform()

MediaWiki\OutputTransform\ContentHolderTransformStage::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

Reimplemented from MediaWiki\OutputTransform\OutputTransformStage.

Definition at line 52 of file ContentHolderTransformStage.php.

---

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

• includes/OutputTransform/ContentHolderTransformStage.php