SearchResult.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
class SearchResult {
 
    protected $mRevision = null;
 
    protected $mImage = null;
 
    protected $mTitle;
 
    protected $mText;
 
    protected $searchEngine;
 
    protected $extensionData;
 
    public static function newFromTitle( $title, SearchResultSet $parentSet = null ) {
        $result = new static();
        $result->initFromTitle( $title );
        if ( $parentSet ) {
            $parentSet->augmentResult( $result );
        }
        return $result;
    }
 
    protected function initFromTitle( $title ) {
        $this->mTitle = $title;
        if ( !is_null( $this->mTitle ) ) {
            $id = false;
            Hooks::run( 'SearchResultInitFromTitle', [ $title, &$id ] );
            $this->mRevision = Revision::newFromTitle(
                $this->mTitle, $id, Revision::READ_NORMAL );
            if ( $this->mTitle->getNamespace() === NS_FILE ) {
                $this->mImage = wfFindFile( $this->mTitle );
            }
        }
        $this->searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
    }
 
    function isBrokenTitle() {
        return is_null( $this->mTitle );
    }
 
    function isMissingRevision() {
        return !$this->mRevision && !$this->mImage;
    }
 
    function getTitle() {
        return $this->mTitle;
    }
 
    function getFile() {
        return $this->mImage;
    }
 
    protected function initText() {
        if ( !isset( $this->mText ) ) {
            if ( $this->mRevision != null ) {
                $this->mText = $this->searchEngine->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 ) = $this->searchEngine->userHighlightPrefs();
 
        $h = new SearchHighlighter();
        if ( count( $terms ) > 0 ) {
            if ( $wgAdvancedSearchHighlighting ) {
                return $h->highlightText( $this->mText, $terms, $contextlines, $contextchars );
            } else {
                return $h->highlightSimple( $this->mText, $terms, $contextlines, $contextchars );
            }
        } else {
            return $h->highlightNone( $this->mText, $contextlines, $contextchars );
        }
    }
 
    function getTitleSnippet() {
        return '';
    }
 
    function getRedirectSnippet() {
        return '';
    }
 
    function getRedirectTitle() {
        return null;
    }
 
    function getSectionSnippet() {
        return '';
    }
 
    function getSectionTitle() {
        return null;
    }
 
    public function getCategorySnippet() {
        return '';
    }
 
    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 getInterwikiPrefix() {
        return '';
    }
 
    function getInterwikiNamespaceText() {
        return '';
    }
 
    function isFileMatch() {
        return false;
    }
 
    public function getExtensionData() {
        if ( $this->extensionData ) {
            return call_user_func( $this->extensionData );
        } else {
            return [];
        }
    }
 
    public function setExtensionData( $extensionData ) {
        if ( $extensionData instanceof Closure ) {
            $this->extensionData = $extensionData;
        } elseif ( is_array( $extensionData ) ) {
            wfDeprecated( __METHOD__ . ' with array argument', 1.32 );
            $this->extensionData = function () use ( $extensionData ) {
                return $extensionData;
            };
        } else {
            $type = is_object( $extensionData )
                ? get_class( $extensionData )
                : gettype( $extensionData );
            throw new \InvalidArgumentException(
                __METHOD__ . " must be called with Closure|array, but received $type" );
        }
    }
}