Definition of a mapping for the search index field. More...

Namespaces
namespace	Entity

namespace	Hook

namespace	SearchWidgets

Classes
class	BaseSearchResultSet
	BaseSearchResultSet is the base class that must be extended by SearchEngine search result set implementations. More...

class	DummySearchIndexFieldDefinition
	Dummy implementation of SearchIndexFieldDefinition for testing purposes. More...

class	FauxSearchResult
	A manually constructed search result, for use with FauxSearchResultSet. More...

class	FauxSearchResultSet
	A manually constructed search result set. More...

interface	ISearchResultSet
	A set of SearchEngine results. More...

class	NullIndexField
	Null index field - means search engine does not implement this field. More...

interface	PaginatingSearchEngine
	Marker class for search engines that can handle their own pagination, by reporting in their ISearchResultSet when a next page is available. More...

class	ParserOutputSearchDataExtractor
	Extracts data from ParserOutput for indexing in the search engine. More...

class	PerRowAugmentor
	Perform augmentation of each row and return composite result, indexed by ID. More...

class	PrefixSearch
	Handles searching prefixes of titles and finding any page names that match. More...

interface	ResultAugmentor
	Augment search results. More...

interface	ResultSetAugmentor
	Augment search results. More...

class	RevisionSearchResult
	SearchResult class based on the revision information. More...

class	SearchDatabase
	Base search engine base class for database-backed searches. More...

class	SearchEngine
	Contain a class for special pages. More...

class	SearchEngineConfig
	Configuration handling class for SearchEngine. More...

class	SearchEngineDummy
	Dummy class to be used when non-supported Database engine is present. More...

class	SearchEngineFactory
	Factory class for SearchEngine. More...

class	SearchEventIngress
	The ingress adapter for the search component. More...

class	SearchExactMatchRescorer
	An utility class to rescore search results by looking for an exact match in the db and add the page found to the first position. More...

class	SearchHighlighter
	Highlight bits of wikitext. More...

interface	SearchIndexField

class	SearchIndexFieldDefinition
	Basic infrastructure of the field definition. More...

class	SearchMySQL
	Search engine hook for MySQL. More...

class	SearchNearMatchResultSet
	A ISearchResultSet wrapper for TitleMatcher. More...

class	SearchPostgres
	Search engine hook base class for Postgres. More...

class	SearchResult
	An abstract base class representing a search engine result. More...

class	SearchResultSet

class	SearchResultThumbnailProvider
	Find thumbnails for search results. More...

class	SearchSqlite
	Search engine hook for SQLite. More...

class	SearchSuggestion
	A search suggestion. More...

class	SearchSuggestionSet
	A set of search suggestions. More...

class	SearchUpdate
	Database independent search index updater. More...

class	SqlSearchResult

class	SqlSearchResultSet
	This class is used for different SQL-based search engines shipped with MediaWiki. More...

class	StringPrefixSearch
	Performs prefix search, returning strings. More...

class	TitleMatcher
	Service implementation of near match title search. More...

class	TitlePrefixSearch
	Performs prefix search, returning Title objects. More...

Functions
	augmentResult (SearchResult $result)
	Returns extra data for specific result and store it in SearchResult object.

	getExtensionData ()
	Get the extension data as: augmentor name => data.

	getIterator ()

	getOffset ()

	setAugmentedData ( $name, $data)
	Sets augmented data for result set.

	setExtensionData ( $extensionData)
	Set extension data for this result.

Variables
trait	SearchResultSetTrait
	Trait useful for SearchResultSet implementations.

trait	SearchResultTrait
	Trait for SearchResult subclasses to share non-obvious behaviors or methods that rarely specialized.

Detailed Description

Definition of a mapping for the search index field.

Must not be implemented directly by extensions, extend SearchIndexFieldDefinition instead.

Stability: stable: to type

Since: 1.28

Function Documentation

◆ augmentResult()

MediaWiki\Search\augmentResult ( SearchResult $result )

Returns extra data for specific result and store it in SearchResult object.

Definition at line 41 of file SearchResultSetTrait.php.

References MediaWiki\Search\SearchResult\getTitle().

Referenced by MediaWiki\Search\SqlSearchResultSet\extractResults().

◆ getExtensionData()

MediaWiki\Search\getExtensionData ( )

Get the extension data as: augmentor name => data.

Returns: array[]

Definition at line 24 of file SearchResultTrait.php.

◆ getIterator()

MediaWiki\Search\getIterator ( )

final

Definition at line 61 of file SearchResultSetTrait.php.

◆ getOffset()

MediaWiki\Search\getOffset ( )

Returns: int|null The offset the current page starts at. Typically this should be null to allow the UI to decide on its own, but in special cases like interleaved AB tests specifying explicitly is necessary.

Definition at line 57 of file SearchResultSetTrait.php.

◆ setAugmentedData()

MediaWiki\Search\setAugmentedData	(		$name,
			$data )

Sets augmented data for result set.

Parameters

string	$name	Extra data item name
array[]	$data	Extra data as PAGEID => data

Definition at line 32 of file SearchResultSetTrait.php.

◆ setExtensionData()

MediaWiki\Search\setExtensionData ( $extensionData )

Set extension data for this result.

The data is: augmentor name => data

Parameters

Closure | array $extensionData Takes no arguments, returns either array of extension data or null.

Definition at line 39 of file SearchResultTrait.php.

References wfDeprecated().

Variable Documentation

◆ SearchResultTrait

trait MediaWiki::Search\SearchResultTrait

Initial value:

{
    
    protected Closure|null $extensionData

Trait for SearchResult subclasses to share non-obvious behaviors or methods that rarely specialized.

Definition at line 12 of file SearchResultTrait.php.

Namespaces

Classes

Functions

Variables