MediaWiki master
MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks Class Reference

Add anchors and other heading formatting, and replace the section link placeholders. More...

Inherits MediaWiki\OutputTransform\ContentDOMTransformStage.

Collaboration diagram for MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks:

Public Member Functions

 __construct (ServiceOptions $options, LoggerInterface $logger, TitleFactory $titleFactory)
 shouldRun (ParserOutput $po, ?ParserOptions $popts, array $options=[])
 Decides whether or not the stage should be run.
 transformDOM (Document $dom, ParserOutput $po, ?ParserOptions $popts, array &$options)
 Applies the transformation to a DOM document.
- Public Member Functions inherited from MediaWiki\OutputTransform\ContentDOMTransformStage
 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

- Public Member Functions inherited from MediaWiki\OutputTransform\OutputTransformStage
 __construct (ServiceOptions $options, LoggerInterface $logger)

Additional Inherited Members

- Public Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage
- Protected Attributes inherited from MediaWiki\OutputTransform\OutputTransformStage
LoggerInterface $logger
ServiceOptions $options

Detailed Description

Add anchors and other heading formatting, and replace the section link placeholders.

Access: internal

Definition at line 26 of file HandleParsoidSectionLinks.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks::__construct ( ServiceOptions $options,
LoggerInterface $logger,
TitleFactory $titleFactory )

Member Function Documentation

◆ shouldRun()

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

Decides whether or not the stage should be run.

Stability: unstable
ParserOptions | null$popts

Reimplemented from MediaWiki\OutputTransform\OutputTransformStage.

Definition at line 37 of file HandleParsoidSectionLinks.php.

◆ transformDOM()

MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks::transformDOM ( Document $dom,
ParserOutput $po,
?ParserOptions $popts,
array & $options )

Applies the transformation to a DOM document.

Reimplemented from MediaWiki\OutputTransform\ContentDOMTransformStage.

Definition at line 47 of file HandleParsoidSectionLinks.php.

References MediaWiki\Parser\ParserOutput\getOutputFlag().

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