MessageContent.php

Go to the documentation of this file.

<?php
class MessageContent extends AbstractContent {

    protected $mMessage;

    public function __construct( $msg, $params = null ) {
        # XXX: messages may be wikitext, html or plain text! and maybe even something else entirely.
        parent::__construct( CONTENT_MODEL_WIKITEXT );

        if ( is_string( $msg ) ) {
            $this->mMessage = wfMessage( $msg );
        } else {
            $this->mMessage = clone $msg;
        }

        if ( $params ) {
            $this->mMessage = $this->mMessage->params( $params );
        }
    }

    public function getHtml() {
        return $this->mMessage->parse();
    }

    public function getWikitext() {
        return $this->mMessage->text();
    }

    public function getNativeData() {
        //NOTE: Message objects are mutable. Cloning here makes MessageContent immutable.
        return clone $this->mMessage;
    }

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

    public function getWikitextForTransclusion() {
        return $this->getWikitext();
    }

    public function getTextForSummary( $maxlength = 250 ) {
        return substr( $this->mMessage->plain(), 0, $maxlength );
    }

    public function getSize() {
        return strlen( $this->mMessage->plain() );
    }

    public function copy() {
        // MessageContent is immutable (because getNativeData() returns a clone of the Message object)
        return $this;
    }

    public function isCountable( $hasLinks = null ) {
        return false;
    }

    public function getParserOutput( Title $title, $revId = null,
        ParserOptions $options = null, $generateHtml = true ) {
        if ( $generateHtml ) {
            $html = $this->getHtml();
        } else {
            $html = '';
        }

        $po = new ParserOutput( $html );
        // Message objects are in the user language.
        $po->recordOption( 'userlang' );

        return $po;
    }

}