4 * Created on Oct 13, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ("ApiBase.php");
34 class ApiOpenSearch
extends ApiBase
{
36 public function __construct($main, $action) {
37 parent
:: __construct($main, $action);
40 public function getCustomPrinter() {
41 return $this->getMain()->createPrinterByName('json');
44 public function execute() {
45 $params = $this->extractRequestParams();
46 $search = $params['search'];
47 $limit = $params['limit'];
48 $namespaces = $params['namespace'];
50 // Open search results may be stored for a very long time
51 $this->getMain()->setCacheMaxAge(1200);
53 $srchres = PrefixSearch
::titleSearch( $search, $limit, $namespaces );
55 if( $params['redirects'] ) {
56 foreach( $srchres as &$t ) {
57 $title = Title
::newFromText( $t );
58 if( is_null( $title ) ) {
61 $article = new Article( $title );
62 $redirTitle = $article->getRedirectTarget();
63 if( !is_null( $redirTitle ) ) {
64 $t = $redirTitle->getPrefixedText();
69 // Set top level elements
70 $result = $this->getResult();
71 $result->addValue(null, 0, $search);
72 $result->addValue(null, 1, $srchres);
75 public function getAllowedParams() {
79 ApiBase
:: PARAM_DFLT
=> 10,
80 ApiBase
:: PARAM_TYPE
=> 'limit',
81 ApiBase
:: PARAM_MIN
=> 1,
82 ApiBase
:: PARAM_MAX
=> 100,
83 ApiBase
:: PARAM_MAX2
=> 100
86 ApiBase
:: PARAM_DFLT
=> NS_MAIN
,
87 ApiBase
:: PARAM_TYPE
=> 'namespace',
88 ApiBase
:: PARAM_ISMULTI
=> true
94 public function getParamDescription() {
96 'search' => 'Search string',
97 'limit' => 'Maximum amount of results to return',
98 'namespace' => 'Namespaces to search',
99 'redirects' => 'Resolve redirects',
103 public function getDescription() {
104 return 'This module implements OpenSearch protocol';
107 protected function getExamples() {
109 'api.php?action=opensearch&search=Te'
113 public function getVersion() {
114 return __CLASS__
. ': $Id$';