[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/ -> PrefixSearch.php (summary)

Prefix search of page names. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 328 lines (10 kb)
Included or required:0 times
Referenced: 3 times
Includes or requires: 0 files

Defines 2 classes

TitlePrefixSearch:: (2 methods):
  titles()
  strings()

StringPrefixSearch:: (2 methods):
  titles()
  strings()

Defines 2 functions

  titleSearch()
  search()
  searchWithVariants()
  searchBackend()
  specialSearch()
  defaultSearchBackend()
  validateNamespaces()

Class: TitlePrefixSearch  - X-Ref

Performs prefix search, returning Title objects

titles( array $titles )   X-Ref
No description

strings( array $strings )   X-Ref
No description

Class: StringPrefixSearch  - X-Ref

Performs prefix search, returning strings

titles( array $titles )   X-Ref
No description

strings( array $strings )   X-Ref
No description

Functions
Functions that are not part of a class:

titleSearch( $search, $limit, $namespaces = array()   X-Ref
Do a prefix search of titles and return a list of matching page names.

param: string $search
param: int $limit
param: array $namespaces Used if query is not explicitly prefixed
return: array Array of strings

search( $search, $limit, $namespaces = array()   X-Ref
Do a prefix search of titles and return a list of matching page names.

param: string $search
param: int $limit
param: array $namespaces Used if query is not explicitly prefixed
return: array Array of strings or Title objects

searchWithVariants( $search, $limit, array $namespaces )   X-Ref
Do a prefix search for all possible variants of the prefix

param: string $search
param: int $limit
param: array $namespaces
return: array

searchBackend( $namespaces, $search, $limit )   X-Ref
Do a prefix search of titles and return a list of matching page names.

param: array $namespaces
param: string $search
param: int $limit
return: array Array of strings

specialSearch( $search, $limit )   X-Ref
Prefix search special-case for Special: namespace.

param: string $search Term
param: int $limit Max number of items to return
return: array

defaultSearchBackend( $namespaces, $search, $limit )   X-Ref
Unless overridden by PrefixSearchBackend hook...
This is case-sensitive (First character may
be automatically capitalized by Title::secureAndSpit()
later on depending on $wgCapitalLinks)

param: array $namespaces Namespaces to search in
param: string $search Term
param: int $limit Max number of items to return
return: array Array of Title objects

validateNamespaces( $namespaces )   X-Ref
Validate an array of numerical namespace indexes

param: array $namespaces
return: array (default: contains only NS_MAIN)



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1