MediaWiki REL1_33
StringPrefixSearch Class Reference

Performs prefix search, returning strings. More...

Inheritance diagram for StringPrefixSearch:
Collaboration diagram for StringPrefixSearch:

Protected Member Functions

 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.
 
- Protected Member Functions inherited from PrefixSearch
 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.
 
 validateNamespaces ( $namespaces)
 Validate an array of numerical namespace indexes.
 

Additional Inherited Members

- Public Member Functions inherited from 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)
 
 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 inherited from PrefixSearch
static titleSearch ( $search, $limit, $namespaces=[], $offset=0)
 Do a prefix search of titles and return a list of matching page names.
 

Detailed Description

Performs prefix search, returning strings.

Deprecated:
Since 1.27, Use SearchEngine::prefixSearchSubpages or SearchEngine::completionSearch

Definition at line 28 of file StringPrefixSearch.php.

Member Function Documentation

◆ strings()

StringPrefixSearch::strings ( array  $strings)
protected

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 from PrefixSearch.

Definition at line 36 of file StringPrefixSearch.php.

◆ titles()

StringPrefixSearch::titles ( array  $titles)
protected

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 from PrefixSearch.

Definition at line 30 of file StringPrefixSearch.php.

References $t, and $titles.


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