PrefixSearch Class Reference

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

Inheritance diagram for PrefixSearch:

Public Member Functions
	defaultSearchBackend ( $namespaces, $search, $limit, $offset)
	Unless overridden by PrefixSearchBackend hook... This is case-sensitive (First character may be automatically capitalized by Title::secureAndSpit() later on depending on $wgCapitalLinks)
	search ( $search, $limit, $namespaces=[], $offset=0)
	Do a prefix search of titles and return a list of matching page names.
	searchWithVariants ( $search, $limit, array $namespaces, $offset=0)
	Do a prefix search for all possible variants of the prefix.

Protected Member Functions
	searchBackend ( $namespaces, $search, $limit, $offset)
	Do a prefix search of titles and return a list of matching page names.
	specialSearch ( $search, $limit, $offset)
	Prefix search special-case for Special: namespace.
	strings (array $strings)
	When implemented in a descendant class, receives an array of titles as strings and returns either an unmodified array or an array of Title objects corresponding to strings received.
	titles (array $titles)
	When implemented in a descendant class, receives an array of Title objects and returns either an unmodified array or an array of strings corresponding to titles passed to it.
	validateNamespaces ( $namespaces)
	Validate an array of numerical namespace indexes.

Private Member Functions
	handleResultFromHook ( $srchres, $namespaces, $search, $limit, $offset)

Detailed Description

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

Used largely by the OpenSearch implementation.

Deprecated:

Since 1.27, Use SearchEngine::defaultPrefixSearch or SearchEngine::completionSearch

Stable to extend

Definition at line 33 of file PrefixSearch.php.

Member Function Documentation

defaultSearchBackend()

PrefixSearch::defaultSearchBackend	(		$namespaces,
			$search,
			$limit,
			$offset
	)

Unless overridden by PrefixSearchBackend hook... This is case-sensitive (First character may be automatically capitalized by Title::secureAndSpit() later on depending on $wgCapitalLinks)

Parameters

array | null	$namespaces	Namespaces to search in
string	$search	Term
int	$limit	Max number of items to return
int	$offset	Number of items to skip

Returns

Title[] Array of Title objects

Definition at line 239 of file PrefixSearch.php.

References $dbr, $res, $title, DB_REPLICA, LIST_AND, LIST_OR, NS_MAIN, NS_SPECIAL, specialSearch(), and wfGetDB().

Referenced by searchBackend(), and SearchEngine\simplePrefixSearch().

handleResultFromHook()

PrefixSearch::handleResultFromHook (   $srchres,   $namespaces,   $search,   $limit,   $offset  )

private

Definition at line 135 of file PrefixSearch.php.

Referenced by searchBackend().

search()

PrefixSearch::search	(		$search,
			$limit,
			$namespaces = [],
			$offset = 0
	)

Do a prefix search of titles and return a list of matching page names.

Parameters

string	$search
int	$limit
array	$namespaces	Used if query is not explicitly prefixed
int	$offset	How many results to offset from the beginning

Returns

array Array of strings or Title objects

Definition at line 43 of file PrefixSearch.php.

References searchBackend().

Referenced by searchWithVariants().

searchBackend()

PrefixSearch::searchBackend (   $namespaces,   $search,   $limit,   $offset  )

protected

Do a prefix search of titles and return a list of matching page names.

Parameters

array	$namespaces
string	$search
int	$limit
int	$offset	How many results to offset from the beginning

Returns

array Array of strings

Definition at line 116 of file PrefixSearch.php.

References defaultSearchBackend(), handleResultFromHook(), NS_FILE, NS_MEDIA, NS_SPECIAL, specialSearch(), strings(), and titles().

Referenced by search().

searchWithVariants()

PrefixSearch::searchWithVariants	(		$search,
			$limit,
		array	$namespaces,
			$offset = 0
	)

Do a prefix search for all possible variants of the prefix.

Parameters

string	$search
int	$limit
array	$namespaces
int	$offset	How many results to offset from the beginning

Returns

array

Definition at line 66 of file PrefixSearch.php.

References search().

specialSearch()

PrefixSearch::specialSearch (   $search,   $limit,   $offset  )

protected

Prefix search special-case for Special: namespace.

Parameters

string	$search	Term
int	$limit	Max number of items to return
int	$offset	Number of items to offset

Returns

array

Definition at line 155 of file PrefixSearch.php.

References $keys, $matches, and NS_SPECIAL.

Referenced by defaultSearchBackend(), and searchBackend().

strings()

PrefixSearch::strings ( array  $strings )

abstractprotected

When implemented in a descendant class, receives an array of titles as strings and returns either an unmodified array or an array of Title objects corresponding to strings received.

Parameters

string[]

$strings

Returns

array

Reimplemented in StringPrefixSearch, and TitlePrefixSearch.

Referenced by searchBackend().

titles()

PrefixSearch::titles ( array  $titles )

abstractprotected

When implemented in a descendant class, receives an array of Title objects and returns either an unmodified array or an array of strings corresponding to titles passed to it.

Parameters

array

$titles

Returns

array

Reimplemented in StringPrefixSearch, and TitlePrefixSearch.

Referenced by searchBackend().

validateNamespaces()

PrefixSearch::validateNamespaces (   $namespaces )

protected

Validate an array of numerical namespace indexes.

Parameters

array

$namespaces

Returns

array (default: contains only NS_MAIN)

Definition at line 295 of file PrefixSearch.php.

References NS_MAIN.

---

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

• includes/search/PrefixSearch.php