CirrusSearch
Elasticsearch-powered search for MediaWiki
Loading...
Searching...
No Matches
CirrusSearch\NearMatchPicker Class Reference

Picks the best "near match" title. More...

Public Member Functions

 __construct ( $language, $term, $titles)
 
 pickBest ()
 Pick the best near match if possible.
 

Detailed Description

Picks the best "near match" title.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Constructor & Destructor Documentation

◆ __construct()

CirrusSearch\NearMatchPicker::__construct ( $language,
$term,
$titles )
Parameters
Language$languageto use during normalization process
string$termthe search term
array[]$titlesArray of arrays, each with optional keys: titleMatch => a title if the title matched redirectMatches => an array of redirect matches, one per matched redirect

Member Function Documentation

◆ pickBest()

CirrusSearch\NearMatchPicker::pickBest ( )

Pick the best near match if possible.

Returns
Title|null title if there is a near match and null otherwise

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