Preprocessor.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Parser;
 
use Wikimedia\ObjectCache\WANObjectCache;
 
abstract class Preprocessor {
    public const DOM_FOR_INCLUSION = 1;
    public const DOM_LANG_CONVERSION_DISABLED = 2;
    public const DOM_UNCACHED = 4;
    // Does preprocessing start in Start-Of-Line(SOL) state? Only relevant for Parsoid
    // content, since Parsoid models templates as independent documents in SOL start.
    // This flag is never set by the legacy parser (but see T2529 which has a similar
    // effect).
    public const START_IN_SOL_STATE = 8;
 
    public $parser;
 
    protected $wanCache;
 
    protected $disableLangConversion;
 
    protected $rules = [
        '{' => [
            'end' => '}',
            'names' => [
                2 => 'template',
                3 => 'tplarg',
            ],
            'min' => 2,
            'max' => 3,
        ],
        '[' => [
            'end' => ']',
            'names' => [ 2 => null ],
            'min' => 2,
            'max' => 2,
        ],
        '-{' => [
            'end' => '}-',
            'names' => [ 2 => null ],
            'min' => 2,
            'max' => 2,
        ],
    ];
 
    public function __construct(
        Parser $parser,
        ?WANObjectCache $wanCache = null,
        array $options = []
    ) {
        $this->parser = $parser;
        $this->wanCache = $wanCache ?: WANObjectCache::newEmpty();
        $this->disableLangConversion = !empty( $options['disableLangConversion'] );
    }
 
    public function resetParser( ?Parser $parser ) {
        // @phan-suppress-next-line PhanPossiblyNullTypeMismatchProperty For internal use only
        $this->parser = $parser;
    }
 
    abstract public function newFrame();
 
    abstract public function newCustomFrame( $args );
 
    abstract public function newPartNodeArray( $values );
 
    abstract public function preprocessToObj( $text, $flags = 0 );
}
 
class_alias( Preprocessor::class, 'Preprocessor' );