MediaWiki master
MediaWiki\OutputTransform\Stages\AddRedirectHeader Class Reference

Adds RedirectHeader if it exists. More...

Inherits MediaWiki\OutputTransform\OutputTransformStage.

Collaboration diagram for MediaWiki\OutputTransform\Stages\AddRedirectHeader:

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.

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

Adds RedirectHeader if it exists.

Access: internal

Definition at line 16 of file AddRedirectHeader.php.

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ shouldRun()

MediaWiki\OutputTransform\Stages\AddRedirectHeader::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 25 of file AddRedirectHeader.php.

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

◆ transform()

MediaWiki\OutputTransform\Stages\AddRedirectHeader::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 29 of file AddRedirectHeader.php.

References MediaWiki\OutputTransform\OutputTransformStage\$options.


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