MediaWiki master
|
OutputTransformStages that modify the content as a HTML DOM tree. More...
Inherits MediaWiki\OutputTransform\OutputTransformStage.
Inherited by MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks.
Public Member Functions | |
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.
| |
transformDOM (Document $dom, ParserOutput $po, ?ParserOptions $popts, array &$options) | |
Applies the transformation to a DOM document. | |
Public Member Functions inherited from MediaWiki\OutputTransform\OutputTransformStage | |
shouldRun (ParserOutput $po, ?ParserOptions $popts, array $options=[]) | |
Decides whether or not the stage should be run. | |
OutputTransformStages that modify the content as a HTML DOM tree.
Subclasses are expected to implement ::transformDOM() to mutate the DOM-structured content as a Document in-place.
Definition at line 24 of file ContentDOMTransformStage.php.
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.
Implements MediaWiki\OutputTransform\OutputTransformStage.
Definition at line 29 of file ContentDOMTransformStage.php.
|
abstract |
Applies the transformation to a DOM document.
Reimplemented in MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks.