1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?php
/**
* 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.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @since 1.23
*/
/**
* @ingroup API
*/
class ApiQueryPrefixSearch extends ApiQueryGeneratorBase {
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'ps' );
}
public function execute() {
$this->run();
}
public function executeGenerator( $resultPageSet ) {
$this->run( $resultPageSet );
}
/**
* @param ApiPageSet $resultPageSet
*/
private function run( $resultPageSet = null ) {
$params = $this->extractRequestParams();
$search = $params['search'];
$limit = $params['limit'];
$namespaces = $params['namespace'];
$offset = $params['offset'];
$searcher = new TitlePrefixSearch;
$titles = $searcher->searchWithVariants( $search, $limit + 1, $namespaces, $offset );
if ( $resultPageSet ) {
if ( count( $titles ) > $limit ) {
$this->setContinueEnumParameter( 'offset', $offset + $params['limit'] );
array_pop( $titles );
}
$resultPageSet->populateFromTitles( $titles );
foreach ( $titles as $index => $title ) {
$resultPageSet->setGeneratorData( $title, array( 'index' => $index + $offset + 1 ) );
}
} else {
$result = $this->getResult();
$count = 0;
foreach ( $titles as $title ) {
if ( ++$count > $limit ) {
$this->setContinueEnumParameter( 'offset', $offset + $params['limit'] );
break;
}
$vals = array(
'ns' => intval( $title->getNamespace() ),
'title' => $title->getPrefixedText(),
);
if ( $title->isSpecialPage() ) {
$vals['special'] = true;
} else {
$vals['pageid'] = intval( $title->getArticleId() );
}
$fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
if ( !$fit ) {
$this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
break;
}
}
$result->addIndexedTagName(
array( 'query', $this->getModuleName() ), $this->getModulePrefix()
);
}
}
public function getCacheMode( $params ) {
return 'public';
}
public function getAllowedParams() {
return array(
'search' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true,
),
'namespace' => array(
ApiBase::PARAM_DFLT => NS_MAIN,
ApiBase::PARAM_TYPE => 'namespace',
ApiBase::PARAM_ISMULTI => true,
),
'limit' => array(
ApiBase::PARAM_DFLT => 10,
ApiBase::PARAM_TYPE => 'limit',
ApiBase::PARAM_MIN => 1,
// Non-standard value for compatibility with action=opensearch
ApiBase::PARAM_MAX => 100,
ApiBase::PARAM_MAX2 => 200,
),
'offset' => array(
ApiBase::PARAM_DFLT => 0,
ApiBase::PARAM_TYPE => 'integer',
),
);
}
protected function getExamplesMessages() {
return array(
'action=query&list=prefixsearch&pssearch=meaning'
=> 'apihelp-query+prefixsearch-example-simple',
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Prefixsearch';
}
}
|
