OutputTransformPipeline.php

Go to the documentation of this file.

<?php
declare( strict_types = 1 );
 
namespace MediaWiki\OutputTransform;
 
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Parser\ParserOutputFlags;
 
class OutputTransformPipeline {
 
    private array $stages = [];
 
    public function addStage( OutputTransformStage $stage ): OutputTransformPipeline {
        $this->stages[] = $stage;
        return $this;
    }
 
    public function run( ParserOutput $in, ParserOptions $popts, array $options ): ParserOutput {
        // Initialize some $options from the ParserOutput
        $options += [
            'enableSectionEditLinks' => !$in->getOutputFlag( ParserOutputFlags::NO_SECTION_EDIT_LINKS ),
            'wrapperDivClass' => $in->getWrapperDivClass(),
        ];
        $oldWatcher = false;
        if ( $options['allowClone'] ?? true ) {
            $out = clone $in;
            $oldWatcher = $popts->registerWatcher( $out->recordOption( ... ) );
        } else {
            // T353257: This should be a clone, but we've need to suppress it
            // for some legacy codepaths.
            $out = $in;
        }
 
        foreach ( $this->stages as $stage ) {
            if ( $stage->shouldRun( $out, $popts, $options ) ) {
                // Some stages may (for now) modify $options. See OutputTransformStage documentation for more info.
                $out = $stage->transform( $out, $popts, $options );
            }
        }
        if ( $oldWatcher !== false ) {
            $popts->registerWatcher( $oldWatcher );
        }
        return $out;
    }
}