3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
25 class ApiQueryPrefixSearch
extends ApiQueryGeneratorBase
{
26 public function __construct( $query, $moduleName ) {
27 parent
::__construct( $query, $moduleName, 'ps' );
30 public function execute() {
34 public function executeGenerator( $resultPageSet ) {
35 $this->run( $resultPageSet );
39 * @param ApiPageSet $resultPageSet
41 private function run( $resultPageSet = null ) {
42 $params = $this->extractRequestParams();
43 $search = $params['search'];
44 $limit = $params['limit'];
45 $namespaces = $params['namespace'];
47 $searcher = new TitlePrefixSearch
;
48 $titles = $searcher->searchWithVariants( $search, $limit, $namespaces );
49 if ( $resultPageSet ) {
50 $resultPageSet->populateFromTitles( $titles );
52 $result = $this->getResult();
53 foreach ( $titles as $title ) {
58 'ns' => intval( $title->getNamespace() ),
59 'title' => $title->getPrefixedText(),
61 if ( $title->isSpecialPage() ) {
62 $vals['special'] = '';
64 $vals['pageid'] = intval( $title->getArticleId() );
66 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
71 $result->setIndexedTagName_internal(
72 array( 'query', $this->getModuleName() ), $this->getModulePrefix()
77 public function getCacheMode( $params ) {
81 public function getAllowedParams() {
84 ApiBase
::PARAM_TYPE
=> 'string',
85 ApiBase
::PARAM_REQUIRED
=> true,
88 ApiBase
::PARAM_DFLT
=> NS_MAIN
,
89 ApiBase
::PARAM_TYPE
=> 'namespace',
90 ApiBase
::PARAM_ISMULTI
=> true,
93 ApiBase
::PARAM_DFLT
=> 10,
94 ApiBase
::PARAM_TYPE
=> 'limit',
95 ApiBase
::PARAM_MIN
=> 1,
96 // Non-standard value for compatibility with action=opensearch
97 ApiBase
::PARAM_MAX
=> 100,
98 ApiBase
::PARAM_MAX2
=> 200,
103 public function getExamplesMessages() {
105 'action=query&list=prefixsearch&pssearch=meaning'
106 => 'apihelp-query+prefixsearch-example-simple',
110 public function getHelpUrls() {
111 return 'https://www.mediawiki.org/wiki/API:Prefixsearch';