ContentDOMTransformStage.php

Go to the documentation of this file.

<?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;
use Wikimedia\Parsoid\Utils\DOMCompat;
 
abstract class ContentDOMTransformStage extends OutputTransformStage {
 
    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;
    }
 
    abstract public function transformDOM(
        DocumentFragment $df, ParserOutput $po, ParserOptions $popts, array &$options
    ): DocumentFragment;
 
    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 );
        }
        DOMCompat::append( $el, ...$children );
        return $el;
    }
}