PrefixSearch Class Reference
[Search]

PrefixSearch - 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 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 defaultSearchBackend ($namespaces, $search, $limit)
 Unless overridden by PrefixSearchBackend hook.
static validateNamespaces ($namespaces)
 Validate an array of numerical namespace indexes.


Detailed Description

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

Used largely by the OpenSearch implementation.

Definition at line 10 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
int $limit max number of items to return
Returns:
array of title strings

Definition at line 115 of file PrefixSearch.php.

References $ns.

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:
array $namespaces
string $search
int $limit
Returns:
array of strings

Definition at line 54 of file PrefixSearch.php.

References $ns, defaultSearchBackend(), specialSearch(), and wfRunHooks().

Referenced by titleSearch().

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

Prefix search special-case for Special: namespace.

Definition at line 73 of file PrefixSearch.php.

References $keys, SpecialPage::$mList, $page, $wgContLang, SpecialPage::initAliasList(), SpecialPage::initList(), and Title::makeTitle().

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:
string $search
int $limit
array $namespaces - used if query is not explicitely prefixed
Returns:
array of strings

Definition at line 18 of file PrefixSearch.php.

References $ns, $title, Title::newFromText(), searchBackend(), and validateNamespaces().

Referenced by ApiOpenSearch::execute().

static PrefixSearch::validateNamespaces ( namespaces  )  [static, protected]

Validate an array of numerical namespace indexes.

Parameters:
array $namespaces

Definition at line 152 of file PrefixSearch.php.

References $ns, and $wgContLang.

Referenced by titleSearch().


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

Generated on Sat Sep 5 02:08:44 2009 for MediaWiki by  doxygen 1.5.9