OutputTransformStages that only modify the content. More...

Inherits MediaWiki\OutputTransform\OutputTransformStage, and MediaWiki\OutputTransform\TextTransformStage.

Inherited by MediaWiki\OutputTransform\Stages\AddWrapperDivClass, MediaWiki\OutputTransform\Stages\ExecutePostCacheTransformHooks, MediaWiki\OutputTransform\Stages\ExpandToAbsoluteUrlsText, MediaWiki\OutputTransform\Stages\HandleSectionLinks, MediaWiki\OutputTransform\Stages\HandleTOCMarkersText, MediaWiki\OutputTransform\Stages\HardenNFC, and MediaWiki\OutputTransform\Stages\HydrateHeaderPlaceholders.

Collaboration diagram for MediaWiki\OutputTransform\ContentTextTransformStage:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, LoggerInterface $logger, private readonly bool $transformBodyOnly,)

	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,)

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

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

	transformText (string $text, ParserOutput $po, ParserOptions $popts, array &$options)

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 only modify the content.

It is expected that all inheriting classes call this class' transform() method (either directly by inheritance or by calling them in the overloaded method).

Access: internal

Definition at line 17 of file ContentTextTransformStage.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\OutputTransform\ContentTextTransformStage::__construct	(	ServiceOptions	$options,
		LoggerInterface	$logger,
		private readonly bool	$transformBodyOnly )

Definition at line 20 of file ContentTextTransformStage.php.

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

Member Function Documentation

◆ getFragmentsToTransform()

MediaWiki\OutputTransform\ContentTextTransformStage::getFragmentsToTransform	(	ParserOutput	$po,
		ParserOptions	$popts )

protected

Override this method if you need more control over which fragments should be transformed.

Definition at line 32 of file ContentTextTransformStage.php.

◆ transform()

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