Page MenuHomeWickedGov Phorge
Files F1429954

ContentDOMTransformStage.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ContentDOMTransformStage.php
View Options

<?php
declare( strict_types = 1 );
namespace MediaWiki\OutputTransform;
use MediaWiki\Parser\ContentHolder;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\ParserOutput;
use Wikimedia\Parsoid\DOM\Document;
use Wikimedia\Parsoid\DOM\DocumentFragment;
use Wikimedia\Parsoid\DOM\Element;
use Wikimedia\Parsoid\DOM\Node;
/**
* 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.
*
* @internal
*/
abstract class ContentDOMTransformStage extends OutputTransformStage {
/**
* @inheritDoc
*/
public function transform(
ParserOutput $po, ?ParserOptions $popts, array &$options
): ParserOutput {
$contentHolder = $po->getContentHolder();
$df = $contentHolder->getAsDom( ContentHolder::BODY_FRAGMENT ) ??
$contentHolder->createFragment();
$df = $this->transformDOM( $df, $po, $popts, $options );
$contentHolder->setAsDom( ContentHolder::BODY_FRAGMENT, $df );
return $po;
}
/** Applies the transformation to a DOM document */
abstract public function transformDOM(
DocumentFragment $df, ParserOutput $po, ?ParserOptions $popts, array &$options
): DocumentFragment;
/**
* Helper method for DOM transforms to easily create DOM Elements with
* the given attributes and children.
*
* @param Document $doc Document holding the new element
* @param string $name Lowercase tag name of the new element
* @param array<string,string> $attribs Associative array between the
* name and (unescaped) value of the attributes of the new element
* @param 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.
* @return Element
* @throws \DOMException
*/
public function createElement(
Document $doc, string $name, array $attribs = [], Node|string ...$children
): Element {
$el = $doc->createElement( $name );
foreach ( $attribs as $key => $value ) {
$el->setAttribute( $key, $value );
}
foreach ( $children as $c ) {
if ( is_string( $c ) ) {
$c = $doc->createTextNode( $c );
}
$el->appendChild( $c );
}
return $el;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 18:13 (7 h, 49 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b4/58/b52cd2db27be7b4daa66d5819b7c
Default Alt Text
ContentDOMTransformStage.php (2 KB)

Event Timeline