MediaWiki master
MediaWiki\OutputTransform\ContentTextTransformStage Class Reference

OutputTransformStages that only modify the content. More...

Inherits MediaWiki\OutputTransform\OutputTransformStage.

Inherited by 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\HandleSectionLinks, MediaWiki\OutputTransform\Stages\HandleTOCMarkers, MediaWiki\OutputTransform\Stages\HydrateHeaderPlaceholders, and MediaWiki\OutputTransform\Stages\RenderDebugInfo.

Collaboration diagram for MediaWiki\OutputTransform\ContentTextTransformStage:

Public Member Functions

 transform (ParserOutput $po, ?ParserOptions $popts, array &$options)
 Transforms the input ParserOutput into the returned ParserOutput.
- Public Member Functions inherited from MediaWiki\OutputTransform\OutputTransformStage
 shouldRun (ParserOutput $po, ?ParserOptions $popts, array $options=[])
 Decides whether or not the stage should be run.

Protected Member Functions

 transformText (string $text, ParserOutput $po, ?ParserOptions $popts, array &$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 13 of file ContentTextTransformStage.php.

Member Function Documentation

◆ 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.

Stability: unstable

Implements MediaWiki\OutputTransform\OutputTransformStage.

Definition at line 15 of file ContentTextTransformStage.php.

◆ transformText()

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