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 ("ApiFormatBase.php");
32 class ApiOpenSearch
extends ApiFormatBase
{
34 private $mResult = array();
36 public function __construct($main, $action) {
37 parent
:: __construct($main, 'opensearch');
40 public function getMimeType() {
41 return 'application/json';
44 public function execute() {
46 extract($this->ExtractRequestParams());
48 // Prepare nested request
49 $params = new FauxRequest(array (
54 'apprefix' => $command
58 $module = new ApiMain($params);
62 $result =& $module->getResult();
63 $result->SanitizeData();
64 $data = $result->GetData();
66 // Reformat useful data for future printing
68 foreach ($data['query']['allpages'] as $pageid => &$pageinfo) {
69 $result[] = $pageinfo['title'];
72 $this->mResult
= array($command, $result);
75 public function executePrinter() {
76 $json = new Services_JSON();
77 $this->printText($json->encode($this->mResult
, true));
80 protected function GetAllowedParams() {
86 protected function GetParamDescription() {
88 'command' => 'Search string'
92 protected function GetDescription() {
93 return 'This module implements OpenSearch protocol';
96 protected function GetExamples() {
98 'api.php?action=opensearch&command=Te'
102 public function getVersion() {
103 return __CLASS__
. ': $Id$';