SearchSuggestion.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Search;
 
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
 
class SearchSuggestion {
    private $text;
 
    private $url;
 
    private $suggestedTitle;
 
    private $suggestedTitleID;
 
    private $score;
 
    public function __construct( $score, $text = null, ?Title $suggestedTitle = null,
            $suggestedTitleID = null ) {
        $this->score = $score;
        $this->text = $text;
        if ( $suggestedTitle ) {
            $this->setSuggestedTitle( $suggestedTitle );
        }
        $this->suggestedTitleID = $suggestedTitleID;
    }
 
    public function getText() {
        return $this->text;
    }
 
    public function setText( $text, $setTitle = true ) {
        $this->text = $text;
        if ( $setTitle && $text !== '' && $text !== null ) {
            $this->setSuggestedTitle( Title::makeTitle( 0, $text ) );
        }
    }
 
    public function getSuggestedTitle() {
        return $this->suggestedTitle;
    }
 
    public function setSuggestedTitle( ?Title $title = null ) {
        $this->suggestedTitle = $title;
        if ( $title !== null ) {
            $urlUtils = MediaWikiServices::getInstance()->getUrlUtils();
            $this->url = $urlUtils->expand( $title->getFullURL(), PROTO_CURRENT ) ?? false;
        }
    }
 
    public function getSuggestedTitleID() {
        return $this->suggestedTitleID;
    }
 
    public function setSuggestedTitleID( $suggestedTitleID = null ) {
        $this->suggestedTitleID = $suggestedTitleID;
    }
 
    public function getScore() {
        return $this->score;
    }
 
    public function setScore( $score ) {
        $this->score = $score;
    }
 
    public function getURL() {
        return $this->url;
    }
 
    public function setURL( $url ) {
        $this->url = $url;
    }
 
    public static function fromTitle( $score, Title $title ) {
        return new self( $score, $title->getPrefixedText(), $title, $title->getArticleID() );
    }
 
    public static function fromText( $score, $text ) {
        $suggestion = new self( $score, $text );
        if ( $text ) {
            $suggestion->setSuggestedTitle( Title::newFromText( $text ) );
        }
        return $suggestion;
    }
 
}
 
class_alias( SearchSuggestion::class, 'SearchSuggestion' );