5 * Created on Oct 13, 2006
7 * API for MediaWiki 1.8+
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * http://www.gnu.org/copyleft/gpl.html
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ("ApiBase.php");
32 class ApiOpenSearch
extends ApiBase
{
34 public function __construct($main, $action) {
35 parent
:: __construct($main, $action);
38 public function getCustomPrinter() {
39 return $this->getMain()->createPrinterByName('json');
42 public function execute() {
44 extract($this->ExtractRequestParams());
46 // Prepare nested request
47 $params = new FauxRequest(array (
56 $module = new ApiMain($params);
60 $result =& $module->getResult();
61 $result->SanitizeData();
62 $data =& $result->GetData();
64 // Reformat useful data for future printing by JSON engine
66 foreach ($data['query']['allpages'] as $pageid => &$pageinfo) {
67 // Note: this data will no be printable by the xml engine
68 // because it does not support lists of unnamed items
69 $srchres[] = $pageinfo['title'];
72 // Set top level elements
73 $result = $this->getResult();
74 $result->addValue(null, 0, $search);
75 $result->addValue(null, 1, $srchres);
78 protected function GetAllowedParams() {
84 protected function GetParamDescription() {
86 'search' => 'Search string'
90 protected function GetDescription() {
91 return 'This module implements OpenSearch protocol';
94 protected function GetExamples() {
96 'api.php?action=opensearch&search=Te'
100 public function getVersion() {
101 return __CLASS__
. ': $Id$';