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.

Collaboration diagram for MediaWiki\OutputTransform\OutputTransformStage:

[legend]

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

	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 Attributes
const	CONSTRUCTOR_OPTIONS = []

Protected Attributes
LoggerInterface	$logger

ServiceOptions	$options

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 16 of file OutputTransformStage.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\OutputTransform\OutputTransformStage::__construct	(	ServiceOptions	$options,
		LoggerInterface	$logger )

Access: internal

Definition at line 24 of file OutputTransformStage.php.

References MediaWiki\OutputTransform\OutputTransformStage\$logger, MediaWiki\OutputTransform\OutputTransformStage\$options, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ shouldRun()

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

abstract

Decides whether or not the stage should be run.

Parameters

ParserOutput $po

Stability: unstable

Parameters

ParserOptions \| null	$popts
array	$options

Returns: bool

◆ transform()

MediaWiki\OutputTransform\OutputTransformStage::transform	(	ParserOutput	$po,
		?ParserOptions	$popts,
		array &	$options )

abstract

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 in MediaWiki\OutputTransform\ContentDOMTransformStage, and MediaWiki\OutputTransform\ContentTextTransformStage.

Member Data Documentation

◆ $logger

LoggerInterface MediaWiki\OutputTransform\OutputTransformStage::$logger

protected

Definition at line 18 of file OutputTransformStage.php.

◆ $options

ServiceOptions MediaWiki\OutputTransform\OutputTransformStage::$options

protected

Definition at line 17 of file OutputTransformStage.php.

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\OutputTransform\OutputTransformStage::CONSTRUCTOR_OPTIONS = []

Access: internal

Definition at line 21 of file OutputTransformStage.php.

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

includes/OutputTransform/OutputTransformStage.php

Public Member Functions

Public Attributes

Protected Attributes