includes/api/ApiOpenSearch.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Oct 13, 2006
   6  *
   7  * API for MediaWiki 1.8+
   8  *
   9  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
  10  *
  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.
  15  *
  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.
  20  *
  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
  25  */
  26
  27 if (!defined('MEDIAWIKI')) {
  28         // Eclipse helper - will be ignored in production
  29         require_once ("ApiBase.php");
  30 }
  31
  32 class ApiOpenSearch extends ApiBase {
  33
  34         public function __construct($main, $action) {
  35                 parent :: __construct($main, $action);
  36         }
  37
  38         public function getCustomPrinter() {
  39                 return $this->getMain()->createPrinterByName('json');
  40         }
  41
  42         public function execute() {
  43                 $search = null;
  44                 extract($this->ExtractRequestParams());
  45
  46                 // Prepare nested request
  47                 $params = new FauxRequest(array (
  48                         'action' => 'query',
  49                         'list' => 'allpages',
  50                         'apnamespace' => 0,
  51                         'aplimit' => 10,
  52                         'apprefix' => $search
  53                 ));
  54
  55                 // Execute
  56                 $module = new ApiMain($params);
  57                 $module->execute();
  58
  59                 // Get clean data
  60                 $data =& $module->getResultData();
  61
  62                 // Reformat useful data for future printing by JSON engine
  63                 $srchres = array();
  64                 foreach ($data['query']['allpages'] as $pageid => &$pageinfo) {
  65                         // Note: this data will no be printable by the xml engine
  66                         // because it does not support lists of unnamed items
  67                         $srchres[] = $pageinfo['title'];
  68                 }
  69
  70                 // Set top level elements
  71                 $result = $this->getResult();
  72                 $result->addValue(null, 0, $search);
  73                 $result->addValue(null, 1, $srchres);
  74         }
  75
  76         protected function GetAllowedParams() {
  77                 return array (
  78                         'search' => null
  79                 );
  80         }
  81
  82         protected function GetParamDescription() {
  83                 return array (
  84                         'search' => 'Search string'
  85                 );
  86         }
  87
  88         protected function GetDescription() {
  89                 return 'This module implements OpenSearch protocol';
  90         }
  91
  92         protected function GetExamples() {
  93                 return array (
  94                         'api.php?action=opensearch&search=Te'
  95                 );
  96         }
  97
  98         public function getVersion() {
  99                 return __CLASS__ . ': $Id$';
 100         }
 101 }
 102 ?>