TextContent.php

Go to the documentation of this file.

<?php

class TextContent extends AbstractContent {

        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." );

                        $text = '';
                }

                if ( !is_string( $text ) ) {
                        throw new MWException( "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 ) {
                global $wgContLang;

                $text = $this->getNativeData();

                $truncatedtext = $wgContLang->truncate(
                        preg_replace( "/[\n\r]/", ' ', $text ),
                        max( 0, $maxlength ) );

                return $truncatedtext;
        }

        public function getSize( ) {
                $text = $this->getNativeData( );
                return strlen( $text );
        }

        public function isCountable( $hasLinks = null ) {
                global $wgArticleCountMethod;

                if ( $this->isRedirect( ) ) {
                        return false;
                }

                if ( $wgArticleCountMethod === 'any' ) {
                        return true;
                }

                return false;
        }

        public function getNativeData( ) {
                $text = $this->mText;
                return $text;
        }

        public function getTextForSearchIndex( ) {
                return $this->getNativeData();
        }

        public function getWikitextForTransclusion( ) {
                $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );

                if ( $wikitext ) {
                        return $wikitext->getNativeData();
                } else {
                        return false;
                }
        }

        public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
                $text = $this->getNativeData();
                $pst = rtrim( $text );

                return ( $text === $pst ) ? $this : new WikitextContent( $pst );
        }

        public function diff( Content $that, Language $lang = null ) {
                global $wgContLang;

                $this->checkModelID( $that->getModel() );

                # @todo: could implement this in DifferenceEngine and just delegate here?

                if ( !$lang ) $lang = $wgContLang;

                $otext = $this->getNativeData();
                $ntext = $this->getNativeData();

                # Note: Use native PHP diff, external engines don't give us abstract output
                $ota = explode( "\n", $wgContLang->segmentForDiff( $otext ) );
                $nta = explode( "\n", $wgContLang->segmentForDiff( $ntext ) );

                $diff = new Diff( $ota, $nta );
                return $diff;
        }


        public function getParserOutput( Title $title,
                $revId = null,
                ParserOptions $options = null, $generateHtml = true
        ) {
                global $wgParser, $wgTextModelsToParse;

                if ( !$options ) {
                        //NOTE: use canonical options per default to produce cacheable output
                        $options = $this->getContentHandler()->makeParserOptions( 'canonical' );
                }

                if ( in_array( $this->getModel(), $wgTextModelsToParse ) ) {
                        // parse just to get links etc into the database
                        $po = $wgParser->parse( $this->getNativeData(), $title, $options, true, true, $revId );
                } else {
                        $po = new ParserOutput();
                }

                if ( $generateHtml ) {
                        $html = $this->getHtml();
                } else {
                        $html = '';
                }

                $po->setText( $html );
                return $po;
        }

        protected function getHtml() {
                return $this->getHighlightHtml();
        }

        protected function getHighlightHtml( ) {
                # TODO: make Highlighter interface, use highlighter here, if available
                return htmlspecialchars( $this->getNativeData() );
        }

        public function convert( $toModel, $lossy = '' ) {
                $converted = parent::convert( $toModel, $lossy );

                if ( $converted !== false ) {
                        return $converted;
                }

                $toHandler = ContentHandler::getForModelID( $toModel );

                if ( $toHandler instanceof TextContentHandler ) {
                        //NOTE: ignore content serialization format - it's just text anyway.
                        $text = $this->getNativeData();
                        $converted = $toHandler->unserializeContent( $text );
                }

                return $converted;
        }
}