TextContent.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Content;
 
use InvalidArgumentException;
use MediaWiki\Language\Language;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use Wikimedia\Diff\Diff;
 
class TextContent extends AbstractContent {
 
    protected $mText;
 
    public function __construct( $text, $model_id = CONTENT_MODEL_TEXT ) {
        parent::__construct( $model_id );
 
        if ( $text === null || $text === false ) {
            wfWarn( "TextContent constructed with \$text = " . var_export( $text, true ) . "! "
                . "This may indicate an error in the caller's scope.", 2 );
 
            $text = '';
        }
 
        if ( !is_string( $text ) ) {
            throw new InvalidArgumentException( "TextContent expects a string in the constructor." );
        }
 
        $this->mText = $text;
    }
 
    public function copy() {
        return $this; # NOTE: this is ok since TextContent are immutable.
    }
 
    public function getTextForSummary( $maxlength = 250 ) {
        $text = $this->getText();
 
        $truncatedtext = MediaWikiServices::getInstance()->getContentLanguage()->
            truncateForDatabase( preg_replace( "/[\n\r]/", ' ', $text ), max( 0, $maxlength ) );
 
        return $truncatedtext;
    }
 
    public function getSize() {
        $text = $this->getText();
 
        return strlen( $text );
    }
 
    public function isCountable( $hasLinks = null ) {
        $articleCountMethod = MediaWikiServices::getInstance()->getMainConfig()->get(
            MainConfigNames::ArticleCountMethod );
 
        if ( $this->isRedirect() ) {
            return false;
        }
 
        if ( $articleCountMethod === 'any' ) {
            return true;
        }
 
        return false;
    }
 
    public function getText() {
        return $this->mText;
    }
 
    public function getTextForSearchIndex() {
        return $this->getText();
    }
 
    public function getWikitextForTransclusion() {
        $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );
        '@phan-var WikitextContent $wikitext';
 
        if ( $wikitext ) {
            return $wikitext->getText();
        } else {
            return false;
        }
    }
 
    public static function normalizeLineEndings( $text ) {
        return str_replace( [ "\r\n", "\r" ], "\n", rtrim( $text ) );
    }
 
    public function diff( Content $that, ?Language $lang = null ) {
        $this->checkModelID( $that->getModel() );
        '@phan-var self $that';
        // @todo could implement this in DifferenceEngine and just delegate here?
 
        if ( !$lang ) {
            $lang = MediaWikiServices::getInstance()->getContentLanguage();
        }
 
        $otext = $this->getText();
        $ntext = $that->getText();
 
        # Note: Use native PHP diff, external engines don't give us abstract output
        $ota = explode( "\n", $lang->segmentForDiff( $otext ) );
        $nta = explode( "\n", $lang->segmentForDiff( $ntext ) );
 
        $diff = new Diff( $ota, $nta );
 
        return $diff;
    }
 
    public function convert( $toModel, $lossy = '' ) {
        $converted = parent::convert( $toModel, $lossy );
 
        if ( $converted !== false ) {
            return $converted;
        }
 
        $toHandler = $this->getContentHandlerFactory()->getContentHandler( $toModel );
 
        if ( $toHandler instanceof TextContentHandler ) {
            // NOTE: ignore content serialization format - it's just text anyway.
            $text = $this->getText();
            $converted = $toHandler->unserializeContent( $text );
        }
 
        return $converted;
    }
 
}
class_alias( TextContent::class, 'TextContent' );