ContentHolderTransformStage.php

Go to the documentation of this file.

<?php
declare( strict_types = 1 );
 
namespace MediaWiki\OutputTransform;
 
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\ParserOutput;
use Psr\Log\LoggerInterface;
use Wikimedia\Assert\Assert;
 
class ContentHolderTransformStage extends OutputTransformStage {
    public function __construct(
        ServiceOptions $options,
        LoggerInterface $logger,
        private OutputTransformStage&TextTransformStage $textTransform,
        private OutputTransformStage&DOMTransformStage $domTransform,
        private bool $exclusive = false,
    ) {
        parent::__construct( $options, $logger );
    }
 
    public function shouldRun( ParserOutput $po, ParserOptions $popts, array $options = [] ): bool {
        $textShouldRun = $this->textTransform->shouldRun( $po, $popts, $options );
        $domShouldRun = $this->domTransform->shouldRun( $po, $popts, $options );
        $textClass = $this->textTransform::class;
        $domClass = $this->domTransform::class;
        Assert::invariant( $this->exclusive ?
                !( $textShouldRun && $domShouldRun ) : $textShouldRun === $domShouldRun,
            "Bad pipeline stage definition for $textClass / $domClass"
        );
        return $textShouldRun || $domShouldRun;
    }
 
    public function transform( ParserOutput $po, ParserOptions $popts, array &$options ): ParserOutput {
        $useDom = $this->exclusive ?
            $this->domTransform->shouldRun( $po, $popts, $options ) :
            $po->getContentHolder()->preferDom();
        return $useDom ? $this->domTransform->transform( $po, $popts, $options ) :
            $this->textTransform->transform( $po, $popts, $options );
    }
}