MagicWord.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Parser;
 
use Language;
use MediaWiki\MediaWikiServices;
use MWException;
use StringUtils;
 
class MagicWord {
    public $mId;
 
    public $mSynonyms;
 
    public $mCaseSensitive;
 
    private ?string $mBaseRegex = null;
 
    private $contLang;
 
    public function __construct( $id = null, $syn = [], $cs = false, Language $contLang = null ) {
        $this->mId = $id;
        $this->mSynonyms = (array)$syn;
        $this->mCaseSensitive = $cs;
        $this->contLang = $contLang ?: MediaWikiServices::getInstance()->getContentLanguage();
    }
 
    public function load( $id ) {
        $this->mId = $id;
        $this->contLang->getMagic( $this );
        if ( !$this->mSynonyms ) {
            throw new MWException( "Error: invalid magic word '$id'" );
        }
    }
 
    public function getRegex() {
        return '/' . $this->getBaseRegex() . '/' . $this->getRegexCase();
    }
 
    public function getRegexCase() {
        return $this->mCaseSensitive ? '' : 'iu';
    }
 
    public function getRegexStart() {
        return '/^(?:' . $this->getBaseRegex() . ')/' . $this->getRegexCase();
    }
 
    public function getRegexStartToEnd() {
        return '/^(?:' . $this->getBaseRegex() . ')$/' . $this->getRegexCase();
    }
 
    public function getBaseRegex() {
        if ( $this->mBaseRegex === null ) {
            // Sort the synonyms by length, descending, so that the longest synonym
            // matches in precedence to the shortest
            $synonyms = $this->mSynonyms;
            usort( $synonyms, static fn ( $a, $b ) => strlen( $b ) <=> strlen( $a ) );
            foreach ( $synonyms as &$synonym ) {
                $synonym = preg_quote( $synonym, '/' );
            }
            $this->mBaseRegex = implode( '|', $synonyms );
        }
        return $this->mBaseRegex;
    }
 
    public function match( $text ) {
        return (bool)preg_match( $this->getRegex(), $text );
    }
 
    public function matchStartToEnd( $text ) {
        return (bool)preg_match( $this->getRegexStartToEnd(), $text );
    }
 
    public function matchAndRemove( &$text ) {
        $text = preg_replace( $this->getRegex(), '', $text, -1, $count );
        return (bool)$count;
    }
 
    public function matchStartAndRemove( &$text ) {
        $text = preg_replace( $this->getRegexStart(), '', $text, -1, $count );
        return (bool)$count;
    }
 
    public function replace( $replacement, $subject, $limit = -1 ) {
        $res = preg_replace(
            $this->getRegex(),
            StringUtils::escapeRegexReplacement( $replacement ),
            $subject,
            $limit
        );
        return $res;
    }
 
    public function getSynonym( $i ) {
        return $this->mSynonyms[$i];
    }
 
    public function getSynonyms() {
        return $this->mSynonyms;
    }
 
    public function isCaseSensitive() {
        return $this->mCaseSensitive;
    }
 
    public function getId() {
        return $this->mId;
    }
}
 
class_alias( MagicWord::class, 'MagicWord' );