OutputTransformStage.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;
 
abstract class OutputTransformStage {
    protected ServiceOptions $options;
    protected LoggerInterface $logger;
 
    public const CONSTRUCTOR_OPTIONS = [];
 
    public function __construct( ServiceOptions $options, LoggerInterface $logger ) {
        // Note this is static:: not self:: so we use the subclass options
        $options->assertRequiredOptions( static::CONSTRUCTOR_OPTIONS );
        $this->options = $options;
        $this->logger = $logger;
    }
 
    abstract public function shouldRun( ParserOutput $po, ?ParserOptions $popts, array $options = [] ): bool;
 
    abstract public function transform( ParserOutput $po, ?ParserOptions $popts, array &$options ): ParserOutput;
}