RevisionSearchResultTrait.php

Go to the documentation of this file.

<?php
 
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Title\Title;
 
trait RevisionSearchResultTrait {
    protected $mRevisionRecord = null;
 
    protected $mImage = null;
 
    protected $mTitle;
 
    protected $mText;
 
    protected function initFromTitle( $title ) {
        $this->mTitle = $title;
        if ( $title !== null ) {
            $services = MediaWikiServices::getInstance();
            $id = false;
            ( new HookRunner( $services->getHookContainer() ) )->onSearchResultInitFromTitle( $title, $id );
 
            $this->mRevisionRecord = $services->getRevisionLookup()->getRevisionByTitle(
                $title,
                $id,
                RevisionLookup::READ_NORMAL
            );
            if ( $title->getNamespace() === NS_FILE ) {
                $this->mImage = $services->getRepoGroup()->findFile( $title );
            }
        }
    }
 
    public function isBrokenTitle() {
        return $this->mTitle === null;
    }
 
    public function isMissingRevision() {
        return !$this->mRevisionRecord && !$this->mImage;
    }
 
    public function getTitle() {
        return $this->mTitle;
    }
 
    public function getFile() {
        return $this->mImage;
    }
 
    protected function initText() {
        if ( !isset( $this->mText ) ) {
            if ( $this->mRevisionRecord != null ) {
                $content = $this->mRevisionRecord->getContent( SlotRecord::MAIN );
                $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 getTextSnippetField() {
        return '';
    }
 
    public function getTitleSnippet() {
        return '';
    }
 
    public function getTitleSnippetField() {
        return '';
    }
 
    public function getRedirectSnippet() {
        return '';
    }
 
    public function getRedirectSnippetField() {
        return '';
    }
 
    public function getRedirectTitle() {
        return null;
    }
 
    public function getSectionSnippet() {
        return '';
    }
 
    public function getSectionSnippetField() {
        return '';
    }
 
    public function getSectionTitle() {
        return null;
    }
 
    public function getCategorySnippet() {
        return '';
    }
 
    public function getCategorySnippetField() {
        return '';
    }
 
    public function getTimestamp() {
        if ( $this->mRevisionRecord ) {
            return $this->mRevisionRecord->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;
    }
}