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

Inheritance diagram for PrefixSearch:

[legend]

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.

Static Public Member Functions
static	titleSearch ( $search, $limit, $namespaces=[], $offset=0)
	Do a prefix search of titles and return a list of matching page names.

Protected Member Functions
	extractNamespace ( $input)
	Figure out if given input contains an explicit namespace.

	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::prefixSearchSubpages or SearchEngine::completionSearch

Definition at line 30 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 291 of file PrefixSearch.php.

References $dbr, $limit, $namespaces, $options, $res, $title, as, DB_REPLICA, LIST_AND, LIST_OR, TitleArray\newFromResult(), NS_MAIN, NS_SPECIAL, specialSearch(), and wfGetDB().

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

◆ extractNamespace()

PrefixSearch::extractNamespace ( $input )

protected

Figure out if given input contains an explicit namespace.

Parameters

string $input

Returns: false|array Array of namespace and remaining text, or false if no namespace given.

Definition at line 79 of file PrefixSearch.php.

References $title, and NS_MAIN.

Referenced by search().

◆ handleResultFromHook()

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

private

Definition at line 189 of file PrefixSearch.php.

References $limit, and $namespaces.

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 55 of file PrefixSearch.php.

References $limit, $namespaces, extractNamespace(), list, searchBackend(), and validateNamespaces().

Referenced by searchWithVariants(), PrefixSearchTest\testSearch(), PrefixSearchTest\testSearchBackend(), PrefixSearchTest\testSearchWithOffset(), and titleSearch().

◆ 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 169 of file PrefixSearch.php.

References $limit, $namespaces, 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 118 of file PrefixSearch.php.

References $limit, $namespaces, $wgContLang, as, global, and 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 209 of file PrefixSearch.php.

References $keys, $limit, $page, $special, $wgContLang, as, SpecialPageFactory\getNames(), SpecialPageFactory\getPage(), global, NS_SPECIAL, and use.

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

array $strings

Returns: array

Reimplemented in TitlePrefixSearch, and StringPrefixSearch.

◆ 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 TitlePrefixSearch, and StringPrefixSearch.

Referenced by searchBackend().

◆ titleSearch()

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

static

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

Deprecated:: Since 1.23, use TitlePrefixSearch or StringPrefixSearch classes

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

Definition at line 41 of file PrefixSearch.php.

References $limit, $namespaces, and search().

◆ 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 347 of file PrefixSearch.php.

References $namespaces, $wgContLang, as, global, and NS_MAIN.

Referenced by search().

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

includes/PrefixSearch.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

◆ defaultSearchBackend()

◆ extractNamespace()

◆ handleResultFromHook()

◆ search()

◆ searchBackend()

◆ searchWithVariants()

◆ specialSearch()

◆ strings()

◆ titles()

◆ titleSearch()

◆ validateNamespaces()