RevisionSearchResultTrait.php

Go to the documentation of this file.

<?php

use MediaWiki\MediaWikiServices;

trait RevisionSearchResultTrait {
    protected $mRevision = null;

    protected $mImage = null;

    protected $mTitle;

    protected $mText;

    protected function initFromTitle( $title ) {
        $this->mTitle = $title;
        $services = MediaWikiServices::getInstance();
        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 = $services->getRepoGroup()->findFile( $this->mTitle );
            }
        }
    }

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

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

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

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

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

    public function getTextSnippet( $terms = [] ) {
        return '';
    }

    public function getTitleSnippet() {
        return '';
    }

    public function getRedirectSnippet() {
        return '';
    }

    public function getRedirectTitle() {
        return null;
    }

    public function getSectionSnippet() {
        return '';
    }

    public function getSectionTitle() {
        return null;
    }

    public function getCategorySnippet() {
        return '';
    }

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

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

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

    public function getInterwikiPrefix() {
        return '';
    }

    public function getInterwikiNamespaceText() {
        return '';
    }

    public function isFileMatch() {
        return false;
    }
}