HtmlHelper.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Html;
 
use MediaWiki\Tidy\RemexCompatFormatter;
use Wikimedia\RemexHtml\HTMLData;
use Wikimedia\RemexHtml\Serializer\HtmlFormatter;
use Wikimedia\RemexHtml\Serializer\Serializer;
use Wikimedia\RemexHtml\Tokenizer\Tokenizer;
use Wikimedia\RemexHtml\TreeBuilder\Dispatcher;
use Wikimedia\RemexHtml\TreeBuilder\TreeBuilder;
 
class HtmlHelper {
 
    public static function modifyElements(
        string $htmlFragment,
        callable $shouldModifyCallback,
        callable $modifyCallback,
        bool $html5format = true
    ) {
        if ( $html5format ) {
            $formatter = new class( [], $shouldModifyCallback, $modifyCallback ) extends HtmlFormatter {
                use HtmlHelperTrait;
            };
        } else {
            $formatter = new class( [], $shouldModifyCallback, $modifyCallback ) extends RemexCompatFormatter {
                use HtmlHelperTrait;
            };
        }
        $serializer = new Serializer( $formatter );
        $treeBuilder = new TreeBuilder( $serializer, $html5format ? [] : [
            'ignoreErrors' => true,
            'ignoreNulls' => true,
        ] );
        $dispatcher = new Dispatcher( $treeBuilder );
        $tokenizer = new Tokenizer( $dispatcher, $htmlFragment, $html5format ? [] : [
            // RemexCompatFormatter expects 'ignoreCharRefs' to be used (T354361). The other options are
            // for consistency with RemexDriver and supposedly improve performance.
            'ignoreErrors' => true,
            'ignoreCharRefs' => true,
            'ignoreNulls' => true,
            'skipPreprocess' => true,
        ] );
 
        $tokenizer->execute( [
            'fragmentNamespace' => HTMLData::NS_HTML,
            'fragmentName' => 'body',
        ] );
 
        return $serializer->getResult();
    }
 
}
 
class_alias( HtmlHelper::class, 'MediaWiki\\HtmlHelper' );