wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\Client\DataAccess\Scribunto;

use MediaWiki\Parser\Parser;
use Wikibase\DataModel\Snak\Snak;
use Wikibase\Lib\Formatters\SnakFormatter;
use Wikimedia\Assert\Assert;

/**
 * SnakFormatter decorator that preprocesses any Wikitext it produces.
 * This is needed in order to pass certain Wikitext constructs (extension tags,
 * like "<maplink>") to Scribunto.
 *
 * @license GPL-2.0-or-later
 * @author Marius Hoch
 */
class WikitextPreprocessingSnakFormatter implements SnakFormatter {

    /**
     * @var SnakFormatter
     */
    private $snakFormatter;

    /**
     * @var Parser
     */
    private $parser;

    public function __construct(
        SnakFormatter $snakFormatter,
        Parser $parser
    ) {
        Assert::parameter(
            $snakFormatter->getFormat() === SnakFormatter::FORMAT_WIKI,
            '$snakFormatter',
            '$snakFormatter must produce Wikitext (SnakFormatter::FORMAT_WIKI)'
        );

        $this->snakFormatter = $snakFormatter;
        $this->parser = $parser;
    }

    /**
     * @see SnakFormatter::formatSnak
     *
     * @param Snak $snak
     *
     * @return string preprocessed Wikitext
     */
    public function formatSnak( Snak $snak ) {
        $wikitext = $this->snakFormatter->formatSnak( $snak );

        // This replaces variables (like Parser::recursivePreprocess/
        // Parser::preprocess), but doesn't yet do any unstripping
        // so that wikitext links stay intakt.
        return $this->parser->replaceVariables( $wikitext );
    }

    /**
     * Returns the format ID of the format this formatter generates.
     * This uses the FORMAT_XXX constants defined in OutputFormatSnakFormatterFactory.
     *
     * @return string One of the SnakFormatter::FORMAT_... constants.
     */
    public function getFormat() {
        return $this->snakFormatter->getFormat();
    }

}