OutputTransformStages that modify the content as a HTML DOM tree. More...
Inherits MediaWiki\OutputTransform\OutputTransformStage.
Inherited by MediaWiki\OutputTransform\Stages\DeduplicateStylesDOM, MediaWiki\OutputTransform\Stages\ExpandRelativeAttrs, MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks, MediaWiki\OutputTransform\Stages\HandleTOCMarkersDOM, MediaWiki\OutputTransform\Stages\ParsoidLanguageConverter, and MediaWiki\OutputTransform\Stages\ParsoidLocalization.
Public Member Functions | |
| createElement (Document $doc, string $name, array $attribs=[], Node|string ... $children) | |
| Helper method for DOM transforms to easily create DOM Elements with the given attributes and children. | |
| 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 (DocumentFragment $df, ParserOutput $po, ParserOptions $popts, array &$options) | |
| Applies the transformation to a DOM document. | |
 Public Member Functions inherited from MediaWiki\OutputTransform\OutputTransformStage | |
| __construct (ServiceOptions $options, LoggerInterface $logger) | |
| shouldRun (ParserOutput $po, ParserOptions $popts, array $options=[]) | |
| Decides whether or not the stage should be run. | |
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
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.
- Access: internal
Definition at line 23 of file ContentDOMTransformStage.php.
Member Function Documentation
◆ createElement()
| MediaWiki\OutputTransform\ContentDOMTransformStage::createElement | ( | Document | $doc, |
| string | $name, | ||
| array | $attribs = [], | ||
| Node|string ... | $children ) |
Helper method for DOM transforms to easily create DOM Elements with the given attributes and children.
- Parameters
-
Document $doc Document holding the new element string $name Lowercase tag name of the new element array<string,string> $attribs Associative array between the name and (unescaped) value of the attributes of the new element Node|string ...$children List of child nodes for the new element. Unescaped strings are converted to new Text Nodes before their insertion in the tree.
- Returns
- Element
- Exceptions
-
\DOMException
Definition at line 60 of file ContentDOMTransformStage.php.
◆ transform()
| 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
Reimplemented from MediaWiki\OutputTransform\OutputTransformStage.
Definition at line 28 of file ContentDOMTransformStage.php.
◆ transformDOM()
|
abstract |
Applies the transformation to a DOM document.
Reimplemented in MediaWiki\OutputTransform\Stages\DeduplicateStylesDOM, MediaWiki\OutputTransform\Stages\ExpandRelativeAttrs, MediaWiki\OutputTransform\Stages\HandleParsoidSectionLinks, MediaWiki\OutputTransform\Stages\HandleTOCMarkersDOM, MediaWiki\OutputTransform\Stages\ParsoidLanguageConverter, and MediaWiki\OutputTransform\Stages\ParsoidLocalization.
The documentation for this class was generated from the following file:
- includes/OutputTransform/ContentDOMTransformStage.php
