MediaWiki  master
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
SearchNearMatcher Class Reference

Implementation of near match title search. More...

Collaboration diagram for SearchNearMatcher:
Collaboration graph
[legend]

Public Member Functions

 __construct (Config $config, Language $lang, HookContainer $hookContainer)
 SearchNearMatcher constructor. More...
 
 getNearMatch ( $searchterm)
 If an exact title match can be found, or a very slightly close match, return the title. More...
 
 getNearMatchResultSet ( $searchterm)
 Do a near match (see SearchEngine::getNearMatch) and wrap it into a ISearchResultSet. More...
 

Protected Member Functions

 getNearMatchInternal ( $searchterm)
 Really find the title match. More...
 

Protected Attributes

Config $config
 

Private Attributes

HookRunner $hookRunner
 
Language $language
 Current language. More...
 
ILanguageConverter $languageConverter
 Current language converter. More...
 
WikiPageFactory $wikiPageFactory
 

Detailed Description

Implementation of near match title search.

TODO: split into service/implementation.

Definition at line 12 of file SearchNearMatcher.php.

Constructor & Destructor Documentation

◆ __construct()

SearchNearMatcher::__construct ( Config  $config,
Language  $lang,
HookContainer  $hookContainer 
)

SearchNearMatcher constructor.

Parameters
Config$config
Language$lang
HookContainer$hookContainer

Definition at line 46 of file SearchNearMatcher.php.

References $config, and $lang.

Member Function Documentation

◆ getNearMatch()

SearchNearMatcher::getNearMatch (   $searchterm)

If an exact title match can be found, or a very slightly close match, return the title.

If no match, returns NULL.

Parameters
string$searchterm
Returns
Title

Definition at line 63 of file SearchNearMatcher.php.

References $title, and getNearMatchInternal().

Referenced by getNearMatchInternal(), and getNearMatchResultSet().

◆ getNearMatchInternal()

SearchNearMatcher::getNearMatchInternal (   $searchterm)
protected

Really find the title match.

Parameters
string$searchterm
Returns
null|Title

Definition at line 86 of file SearchNearMatcher.php.

References $matches, $title, getNearMatch(), SpecialPage\getTitleFor(), User\isIP(), Title\makeTitle(), Title\newFromText(), NS_FILE, NS_MEDIA, NS_MEDIAWIKI, and NS_USER.

Referenced by getNearMatch().

◆ getNearMatchResultSet()

SearchNearMatcher::getNearMatchResultSet (   $searchterm)

Do a near match (see SearchEngine::getNearMatch) and wrap it into a ISearchResultSet.

Parameters
string$searchterm
Returns
ISearchResultSet

Definition at line 77 of file SearchNearMatcher.php.

References getNearMatch().

Member Data Documentation

◆ $config

Config SearchNearMatcher::$config
protected

Definition at line 16 of file SearchNearMatcher.php.

Referenced by __construct().

◆ $hookRunner

HookRunner SearchNearMatcher::$hookRunner
private

Definition at line 33 of file SearchNearMatcher.php.

◆ $language

Language SearchNearMatcher::$language
private

Current language.

Definition at line 22 of file SearchNearMatcher.php.

◆ $languageConverter

ILanguageConverter SearchNearMatcher::$languageConverter
private

Current language converter.

Definition at line 28 of file SearchNearMatcher.php.

◆ $wikiPageFactory

WikiPageFactory SearchNearMatcher::$wikiPageFactory
private

Definition at line 38 of file SearchNearMatcher.php.

The documentation for this class was generated from the following file: