PrefixSearch Class Reference

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

List of all members.

Static Public Member Functions
static	titleSearch ($search, $limit, $namespaces=array())
	Do a prefix search of titles and return a list of matching page names.
Static Protected Member Functions
static	defaultSearchBackend ($namespaces, $search, $limit)
	Unless overridden by PrefixSearchBackend hook...
static	searchBackend ($namespaces, $search, $limit)
	Do a prefix search of titles and return a list of matching page names.
static	specialSearch ($search, $limit)
	Prefix search special-case for Special: namespace.
static	validateNamespaces ($namespaces)
	Validate an array of numerical namespace indexes.

---

Detailed Description

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

Used largely by the OpenSearch implementation.

Definition at line 29 of file PrefixSearch.php.

---

Member Function Documentation

static PrefixSearch::defaultSearchBackend	(	$	namespaces,
		$	search,
		$	limit
	)		[static, protected]

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	$namespaces	namespaces to search in
string	$search	term
	$limit	Integer: max number of items to return

Returns:

Array of title strings

Definition at line 155 of file PrefixSearch.php.

References $limit, $namespaces, array(), and as.

Referenced by searchBackend().

static PrefixSearch::searchBackend	(	$	namespaces,
		$	search,
		$	limit
	)		[static, protected]

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

Parameters:

$namespaces	Array
$search	String
$limit	Integer

Returns:

Array of strings

Definition at line 75 of file PrefixSearch.php.

References $limit, $namespaces, array(), defaultSearchBackend(), specialSearch(), and wfRunHooks().

Referenced by titleSearch().

static PrefixSearch::specialSearch	(	$	search,
		$	limit
	)		[static, protected]

Prefix search special-case for Special: namespace.

Parameters:

string	$search	term
	$limit	Integer: max number of items to return

Returns:

Array

Definition at line 98 of file PrefixSearch.php.

References $keys, $limit, $wgContLang, array(), as, bug, SpecialPageFactory\getList(), global, Title\makeTitleSafe(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by searchBackend().

static PrefixSearch::titleSearch	(	$	search,
		$	limit,
		$	namespaces = array()
	)		[static]

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

Parameters:

	$search	String
	$limit	Integer
array	$namespaces	used if query is not explicitly prefixed

Returns:

Array of strings

Definition at line 38 of file PrefixSearch.php.

References $limit, $namespaces, $title, array(), Title\newFromText(), searchBackend(), and validateNamespaces().

Referenced by ApiOpenSearch\execute().

static PrefixSearch::validateNamespaces

(

$

namespaces

)

[static, protected]

Validate an array of numerical namespace indexes.

Parameters:

$namespaces

Array

Returns:

Array (default: contains only NS_MAIN)

Definition at line 194 of file PrefixSearch.php.

References $namespaces, $wgContLang, array(), as, and global.

Referenced by titleSearch().

---

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

• includes/PrefixSearch.php