aboutsummaryrefslogtreecommitdiffstats
path: root/tests/phpunit/mocks/search/MockCompletionSearchEngine.php
blob: ec4016d3d6a1909981680861df31e7729c840b94 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?php

use MediaWiki\Title\Title;

/**
 * SearchEngine implementation for returning mocked completion search results.
 */
class MockCompletionSearchEngine extends SearchEngine {
	/** @var string[][] */
	private static $results = [];

	/**
	 * Reset any mocked results
	 */
	public static function clearMockResults() {
		self::$results = [];
	}

	/**
	 * Allows returning arbitrary lists of titles for completion search.
	 * Provided results will be sliced based on offset/limit of query.
	 *
	 * For results to exit the search engine they must pass Title::isKnown.
	 * Injecting into link cache is not enough, as LinkBatch will mark them
	 * bad, they need to be injected into the DB.
	 *
	 * @param string $query Search term as seen in completionSearchBackend
	 * @param string[] $result List of titles to respond to query with
	 */
	public static function addMockResults( $query, array $result ) {
		// Leading : ensures we don't treat another : as a namespace separator
		$normalized = mb_strtolower( Title::newFromText( ":$query" )->getText() );
		self::$results[$normalized] = $result;
	}

	public function completionSearchBackend( $search ) {
		$search = mb_strtolower( $search );
		if ( !isset( self::$results[$search] ) ) {
			return SearchSuggestionSet::emptySuggestionSet();
		}
		$results = array_slice( self::$results[$search], $this->offset, $this->limit );

		return SearchSuggestionSet::fromStrings( $results );
	}
}