SearchSuggestionSet.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Title\Title;
 
class SearchSuggestionSet {
    private $suggestions = [];
 
    private $pageMap = [];
 
    private $hasMoreResults;
 
    public function __construct( array $suggestions, $hasMoreResults = false ) {
        $this->hasMoreResults = $hasMoreResults;
        foreach ( $suggestions as $suggestion ) {
            $pageID = $suggestion->getSuggestedTitleID();
            if ( $pageID && empty( $this->pageMap[$pageID] ) ) {
                $this->pageMap[$pageID] = true;
            }
            $this->suggestions[] = $suggestion;
        }
    }
 
    public function hasMoreResults() {
        return $this->hasMoreResults;
    }
 
    public function getSuggestions() {
        return $this->suggestions;
    }
 
    public function map( $callback ) {
        return array_map( $callback, $this->suggestions );
    }
 
    public function filter( $callback ) {
        $before = count( $this->suggestions );
        $this->suggestions = array_values( array_filter( $this->suggestions, $callback ) );
        return $before - count( $this->suggestions );
    }
 
    public function append( SearchSuggestion $suggestion ) {
        $pageID = $suggestion->getSuggestedTitleID();
        if ( $pageID && isset( $this->pageMap[$pageID] ) ) {
            return;
        }
        if ( $this->getSize() > 0 && $suggestion->getScore() >= $this->getWorstScore() ) {
            $suggestion->setScore( $this->getWorstScore() - 1 );
        }
        $this->suggestions[] = $suggestion;
        if ( $pageID ) {
            $this->pageMap[$pageID] = true;
        }
    }
 
    public function appendAll( SearchSuggestionSet $set ) {
        foreach ( $set->getSuggestions() as $sugg ) {
            $this->append( $sugg );
        }
    }
 
    public function rescore( $key ) {
        $removed = array_splice( $this->suggestions, $key, 1 );
        unset( $this->pageMap[$removed[0]->getSuggestedTitleID()] );
        $this->prepend( $removed[0] );
    }
 
    public function prepend( SearchSuggestion $suggestion ) {
        $pageID = $suggestion->getSuggestedTitleID();
        if ( $pageID && isset( $this->pageMap[$pageID] ) ) {
            return;
        }
        if ( $this->getSize() > 0 && $suggestion->getScore() <= $this->getBestScore() ) {
            $suggestion->setScore( $this->getBestScore() + 1 );
        }
        array_unshift( $this->suggestions, $suggestion );
        if ( $pageID ) {
            $this->pageMap[$pageID] = true;
        }
    }
 
    public function remove( SearchSuggestion $suggestion ): bool {
        foreach ( $this->suggestions as $k => $s ) {
            $titleId = $s->getSuggestedTitleID();
            if ( ( $titleId != null && $titleId === $suggestion->getSuggestedTitleID() )
                 || $s->getText() === $suggestion->getText() ) {
                array_splice( $this->suggestions, $k, 1 );
                unset( $this->pageMap[$s->getSuggestedTitleID()] );
                return true;
            }
        }
        return false;
    }
 
    public function getBestScore() {
        if ( !$this->suggestions ) {
            return 0;
        }
        return $this->suggestions[0]->getScore();
    }
 
    public function getWorstScore() {
        if ( !$this->suggestions ) {
            return 0;
        }
        return end( $this->suggestions )->getScore();
    }
 
    public function getSize() {
        return count( $this->suggestions );
    }
 
    public function shrink( $limit ) {
        if ( count( $this->suggestions ) > $limit ) {
            $this->suggestions = array_slice( $this->suggestions, 0, $limit );
            $this->pageMap = self::buildPageMap( $this->suggestions );
            $this->hasMoreResults = true;
        }
    }
 
    private static function buildPageMap( array $suggestions ): array {
        $pageMap = [];
        foreach ( $suggestions as $suggestion ) {
            $pageID = $suggestion->getSuggestedTitleID();
            if ( $pageID ) {
                $pageMap[$pageID] = true;
            }
        }
        return $pageMap;
    }
 
    public static function fromTitles( array $titles, $hasMoreResults = false ) {
        $score = count( $titles );
        $suggestions = array_map( static function ( $title ) use ( &$score ) {
            return SearchSuggestion::fromTitle( $score--, $title );
        }, $titles );
        return new SearchSuggestionSet( $suggestions, $hasMoreResults );
    }
 
    public static function fromStrings( array $titles, $hasMoreResults = false ) {
        $score = count( $titles );
        $suggestions = array_map( static function ( $title ) use ( &$score ) {
            return SearchSuggestion::fromText( $score--, $title );
        }, $titles );
        return new SearchSuggestionSet( $suggestions, $hasMoreResults );
    }
 
    public static function emptySuggestionSet() {
        return new SearchSuggestionSet( [] );
    }
}