includes/api/ApiGo.php

   1 <?php
   2
   3 /**
   4  * Created on Mar 30, 2010
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright © 2010 Matthew Britton <Firstname>.<Lastname>@btinternet.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  */
  24
  25 if ( !defined( 'MEDIAWIKI' ) ) {
  26         // Eclipse helper - will be ignored in production
  27         require_once( "ApiBase.php" );
  28 }
  29
  30 /**
  31 * API module to determine the result of a "Go" search
  32 *
  33  * @ingroup API
  34  */
  35 class ApiGo extends ApiBase {
  36         public function __construct( $main, $action ) {
  37                 parent::__construct( $main, $action );
  38         }
  39
  40         public function execute() {
  41                 $params = $this->extractRequestParams();
  42                 $text = $params['text'];
  43
  44                 if ( is_null( $text ) ) {
  45                         $this->dieUsageMsg( array( 'missingparam', 'text' ) );
  46                 }
  47
  48                 // Strip underscores
  49                 $text = str_replace( '_', ' ', $text );
  50
  51                 $nearMatch = SearchEngine::getNearMatch( $text );
  52
  53                 $this->getResult()->addValue( null, $this->getModuleName(), array( 'text' => $text, 'result' => $nearMatch ) );
  54         }
  55
  56         public function mustBePosted() {
  57                 return false;
  58         }
  59
  60         public function isWriteMode() {
  61                 return false;
  62         }
  63
  64         public function getAllowedParams() {
  65                 return array(
  66                         'text' => null,
  67                 );
  68         }
  69
  70         public function getParamDescription() {
  71                 return array(
  72                         'text' => 'Text to try a "Go" match for'
  73                 );
  74         }
  75
  76         public function getDescription() {
  77                 return 'Determine the title one will be taken to by a "Go" search, if any';
  78         }
  79
  80         public function getPossibleErrors() {
  81                 return array_merge( parent::getPossibleErrors(), array(
  82                         array( 'missingparam', 'text' )
  83                 ) );
  84         }
  85
  86         protected function getExamples() {
  87                 return array(
  88                         'api.php?action=go&text=Foo'
  89                 );
  90         }
  91
  92         public function getVersion() {
  93                 return __CLASS__ . ': $Id$';
  94         }
  95 }