MediaWiki\OutputTransform\OutputTransformStage Interface Reference

Classes implementing the OutputTransformStage aim at being added to a pipeline of transformations that transform a ParserOutput. More...

Inherited by MediaWiki\OutputTransform\ContentDOMTransformStage, and MediaWiki\OutputTransform\ContentTextTransformStage.

Public Member Functions
	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.

Detailed Description

Classes implementing the OutputTransformStage aim at being added to a pipeline of transformations that transform a ParserOutput.

The argument ParserOutput can explicitly be modified in place; ensuring that cached objects do not suffer from side effects is the caller's (typically the pipeline's) responsibility.

Stability: unstable

Definition at line 14 of file OutputTransformStage.php.

Member Function Documentation

shouldRun()

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

Decides whether or not the stage should be run.

Parameters

ParserOutput

$po

Stability: unstable

Parameters

ParserOptions | null	$popts
array	$options

Returns

bool

Implemented in MediaWiki\OutputTransform\Stages\AddRedirectHeader, MediaWiki\OutputTransform\Stages\AddWrapperDivClass, MediaWiki\OutputTransform\Stages\DeduplicateStyles, MediaWiki\OutputTransform\Stages\ExecutePostCacheTransformHooks, MediaWiki\OutputTransform\Stages\ExpandToAbsoluteUrls, MediaWiki\OutputTransform\Stages\ExtractBody, MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks, MediaWiki\OutputTransform\Stages\HandleSectionLinks, MediaWiki\OutputTransform\Stages\HandleTOCMarkers, MediaWiki\OutputTransform\Stages\HydrateHeaderPlaceholders, and MediaWiki\OutputTransform\Stages\RenderDebugInfo.

transform()

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

Implemented in MediaWiki\OutputTransform\ContentDOMTransformStage, and MediaWiki\OutputTransform\ContentTextTransformStage.

---

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

• includes/OutputTransform/OutputTransformStage.php