SearchResult.php

Go to the documentation of this file.

<?php
class SearchResult {

    protected $mRevision = null;

    protected $mImage = null;

    protected $mTitle;

    protected $mText;

    public static function newFromTitle( $title ) {
        $result = new self();
        $result->initFromTitle( $title );
        return $result;
    }

    public static function newFromRow( $row ) {
        $result = new self();
        $result->initFromRow( $row );
        return $result;
    }

    public function __construct( $row = null ) {
        if ( !is_null( $row ) ) {
            // Backwards compatibility with pre-1.17 callers
            $this->initFromRow( $row );
        }
    }

    protected function initFromRow( $row ) {
        $this->initFromTitle( Title::makeTitle( $row->page_namespace, $row->page_title ) );
    }

    protected function initFromTitle( $title ) {
        $this->mTitle = $title;
        if ( !is_null( $this->mTitle ) ) {
            $id = false;
            wfRunHooks( 'SearchResultInitFromTitle', array( $title, &$id ) );
            $this->mRevision = Revision::newFromTitle(
                $this->mTitle, $id, Revision::READ_NORMAL );
            if ( $this->mTitle->getNamespace() === NS_FILE ) {
                $this->mImage = wfFindFile( $this->mTitle );
            }
        }
    }

    function isBrokenTitle() {
        return is_null( $this->mTitle );
    }

    function isMissingRevision() {
        return !$this->mRevision && !$this->mImage;
    }

    function getTitle() {
        return $this->mTitle;
    }

    function getFile() {
        return $this->mImage;
    }

    function getScore() {
        return null;
    }

    protected function initText() {
        if ( !isset( $this->mText ) ) {
            if ( $this->mRevision != null ) {
                $this->mText = SearchEngine::create()
                    ->getTextFromContent( $this->mTitle, $this->mRevision->getContent() );
            } else { // TODO: can we fetch raw wikitext for commons images?
                $this->mText = '';
            }
        }
    }

    function getTextSnippet( $terms ) {
        global $wgAdvancedSearchHighlighting;
        $this->initText();

        // TODO: make highliter take a content object. Make ContentHandler a factory for SearchHighliter.
        list( $contextlines, $contextchars ) = SearchEngine::userHighlightPrefs();
        $h = new SearchHighlighter();
        if ( $wgAdvancedSearchHighlighting ) {
            return $h->highlightText( $this->mText, $terms, $contextlines, $contextchars );
        } else {
            return $h->highlightSimple( $this->mText, $terms, $contextlines, $contextchars );
        }
    }

    function getTitleSnippet() {
        return '';
    }

    function getRedirectSnippet() {
        return '';
    }

    function getRedirectTitle() {
        return null;
    }

    function getSectionSnippet() {
        return '';
    }

    function getSectionTitle() {
        return null;
    }

    function getTimestamp() {
        if ( $this->mRevision ) {
            return $this->mRevision->getTimestamp();
        } elseif ( $this->mImage ) {
            return $this->mImage->getTimestamp();
        }
        return '';
    }

    function getWordCount() {
        $this->initText();
        return str_word_count( $this->mText );
    }

    function getByteSize() {
        $this->initText();
        return strlen( $this->mText );
    }

    function hasRelated() {
        return false;
    }

    function getInterwikiPrefix() {
        return '';
    }

    function getInterwikiNamespaceText() {
        return '';
    }

    function isFileMatch() {
        return false;
    }
}