ParserFactory.php

Go to the documentation of this file.

<?php
use MediaWiki\BadFileLookup;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Linker\LinkRendererFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\Special\SpecialPageFactory;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

class ParserFactory {
    private $svcOptions;

    private $magicWordFactory;

    private $contLang;

    private $urlProtocols;

    private $specialPageFactory;

    private $linkRendererFactory;

    private $nsInfo;

    private $logger;

    private $badFileLookup;

    public function __construct(
        $svcOptions,
        MagicWordFactory $magicWordFactory,
        Language $contLang,
        $urlProtocols,
        SpecialPageFactory $spFactory,
        $linkRendererFactory,
        $nsInfo = null,
        $logger = null,
        BadFileLookup $badFileLookup = null
    ) {
        // @todo Do we need to retain compat for constructing this class directly?
        if ( !$nsInfo ) {
            wfDeprecated( __METHOD__ . ' with no NamespaceInfo argument', '1.34' );
            $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
        }
        if ( $linkRendererFactory instanceof Config ) {
            // Old calling convention had an array in the format of $wgParserConf as the first
            // parameter, and a Config as the sixth, with LinkRendererFactory as the seventh.
            wfDeprecated( __METHOD__ . ' with Config parameter', '1.34' );
            $svcOptions = new ServiceOptions( Parser::CONSTRUCTOR_OPTIONS,
                $svcOptions,
                [ 'class' => Parser::class,
                    'preprocessorClass' => Parser::getDefaultPreprocessorClass() ],
                func_get_arg( 5 )
            );
            $linkRendererFactory = func_get_arg( 6 );
            $nsInfo = func_num_args() > 7 ? func_get_arg( 7 ) : null;
        }
        $svcOptions->assertRequiredOptions( Parser::CONSTRUCTOR_OPTIONS );

        wfDebug( __CLASS__ . ": using preprocessor: {$svcOptions->get( 'preprocessorClass' )}\n" );

        $this->svcOptions = $svcOptions;
        $this->magicWordFactory = $magicWordFactory;
        $this->contLang = $contLang;
        $this->urlProtocols = $urlProtocols;
        $this->specialPageFactory = $spFactory;
        $this->linkRendererFactory = $linkRendererFactory;
        $this->nsInfo = $nsInfo;
        $this->logger = $logger ?: new NullLogger();
        $this->badFileLookup = $badFileLookup ??
            MediaWikiServices::getInstance()->getBadFileLookup();
    }

    public function create() : Parser {
        return new Parser(
            $this->svcOptions,
            $this->magicWordFactory,
            $this->contLang,
            $this,
            $this->urlProtocols,
            $this->specialPageFactory,
            $this->linkRendererFactory,
            $this->nsInfo,
            $this->logger,
            $this->badFileLookup
        );
    }
}