WikitextContent.php

Go to the documentation of this file.

<?php
use MediaWiki\Content\TextContent;
use MediaWiki\Context\RequestContext;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\MagicWord;
use MediaWiki\Title\Title;
 
class WikitextContent extends TextContent {
 
    private $preSaveTransformFlags = [];
 
    public function __construct( $text ) {
        parent::__construct( $text, CONTENT_MODEL_WIKITEXT );
    }
 
    public function getSection( $sectionId ) {
        $text = $this->getText();
        $sect = MediaWikiServices::getInstance()->getParserFactory()->getInstance()
            ->getSection( $text, $sectionId, false );
 
        if ( $sect === false ) {
            return false;
        } else {
            return new static( $sect );
        }
    }
 
    public function replaceSection( $sectionId, Content $with, $sectionTitle = '' ) {
        // @phan-suppress-previous-line PhanParamSignatureMismatch False positive
        $myModelId = $this->getModel();
        $sectionModelId = $with->getModel();
 
        if ( $sectionModelId != $myModelId ) {
            throw new InvalidArgumentException( "Incompatible content model for section: " .
                "document uses $myModelId but " .
                "section uses $sectionModelId." );
        }
        '@phan-var self $with';
 
        $oldtext = $this->getText();
        $text = $with->getText();
 
        if ( strval( $sectionId ) === '' ) {
            return $with; # XXX: copy first?
        }
 
        if ( $sectionId === 'new' ) {
            # Inserting a new section
            $subject = strval( $sectionTitle ) !== '' ? wfMessage( 'newsectionheaderdefaultlevel' )
                    ->plaintextParams( $sectionTitle )->inContentLanguage()->text() . "\n\n" : '';
            $hookRunner = ( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) );
            if ( $hookRunner->onPlaceNewSection( $this, $oldtext, $subject, $text ) ) {
                $text = strlen( trim( $oldtext ) ) > 0
                    ? "{$oldtext}\n\n{$subject}{$text}"
                    : "{$subject}{$text}";
            }
        } else {
            # Replacing an existing section; roll out the big guns
            $text = MediaWikiServices::getInstance()->getParserFactory()->getInstance()
                ->replaceSection( $oldtext, $sectionId, $text );
        }
 
        $newContent = new static( $text );
 
        return $newContent;
    }
 
    public function addSectionHeader( $header ) {
        $text = strval( $header ) !== '' ? wfMessage( 'newsectionheaderdefaultlevel' )
            ->plaintextParams( $header )->inContentLanguage()->text() . "\n\n" : '';
        $text .= $this->getText();
 
        return new static( $text );
    }
 
    public function getRedirectTargetAndText() {
        wfDeprecated( __METHOD__, '1.41' );
 
        $handler = $this->getContentHandler();
        [ $target, $content ] = $handler->extractRedirectTargetAndText( $this );
 
        return [ Title::castFromLinkTarget( $target ), $content->getText() ];
    }
 
    public function getRedirectTarget() {
        // TODO: The redirect target should be injected on construction.
        //       But that only works if the object is created by WikitextContentHandler.
 
        $handler = $this->getContentHandler();
        [ $target, ] = $handler->extractRedirectTargetAndText( $this );
 
        return Title::castFromLinkTarget( $target );
    }
 
    public function updateRedirect( Title $target ) {
        if ( !$this->isRedirect() ) {
            return $this;
        }
 
        # Fix the text
        # Remember that redirect pages can have categories, templates, etc.,
        # so the regex has to be fairly general
        $newText = preg_replace( '/ \[ \[  [^\]]*  \] \] /x',
            '[[' . $target->getFullText() . ']]',
            $this->getText(), 1 );
 
        return new static( $newText );
    }
 
    public function isCountable( $hasLinks = null, Title $title = null ) {
        $articleCountMethod = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::ArticleCountMethod );
 
        if ( $this->isRedirect() ) {
            return false;
        }
 
        if ( $articleCountMethod === 'link' ) {
            if ( $hasLinks === null ) { # not known, find out
                // @TODO: require an injected title
                if ( !$title ) {
                    $context = RequestContext::getMain();
                    $title = $context->getTitle();
                }
                $contentRenderer = MediaWikiServices::getInstance()->getContentRenderer();
                // @phan-suppress-next-line PhanTypeMismatchArgumentNullable getTitle does not return null here
                $po = $contentRenderer->getParserOutput( $this, $title, null, null, false );
                $links = $po->getLinks();
                $hasLinks = $links !== [];
            }
 
            return $hasLinks;
        }
 
        return true;
    }
 
    public function getTextForSummary( $maxlength = 250 ) {
        $truncatedtext = parent::getTextForSummary( $maxlength );
 
        # clean up unfinished links
        # XXX: make this optional? wasn't there in autosummary, but required for
        # deletion summary.
        $truncatedtext = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $truncatedtext );
 
        return $truncatedtext;
    }
 
    public function matchMagicWord( MagicWord $word ) {
        return $word->match( $this->getText() );
    }
 
    public function setPreSaveTransformFlags( array $flags ) {
        $this->preSaveTransformFlags = $flags;
    }
 
    public function getPreSaveTransformFlags() {
        return $this->preSaveTransformFlags;
    }
 
    public function getContentHandler(): WikitextContentHandler {
        $handler = parent::getContentHandler();
        '@phan-var WikitextContentHandler $handler';
        return $handler;
    }
}