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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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
  37         /**
  38          * Std ctor.
  39          */
  40         public function __construct( $main, $action ) {
  41                 parent::__construct( $main, $action );
  42         }
  43
  44         public function execute() {
  45                 $params = $this->extractRequestParams();
  46                 $text = $params['text'];
  47
  48                 if ( is_null( $text ) ) {
  49                         $this->dieUsageMsg( array( 'missingparam', 'text' ) );
  50                 }
  51
  52                 // Strip underscores
  53                 $text = str_replace( '_', ' ', $text );
  54
  55                 $nearMatch = SearchEngine::getNearMatch( $text );
  56
  57                 $this->getResult()->addValue( null, $this->getModuleName(), array( 'text' => $text, 'result' => $nearMatch ) );
  58         }
  59
  60         public function mustBePosted() {
  61                 return false;
  62         }
  63
  64         public function isWriteMode() {
  65                 return false;
  66         }
  67
  68         public function getAllowedParams() {
  69                 return array(
  70                         'text' => null,
  71                 );
  72         }
  73
  74         public function getParamDescription() {
  75                 return array(
  76                         'text' => 'Text to try a "Go" match for'
  77                 );
  78         }
  79
  80         public function getDescription() {
  81                 return array(
  82                         'Determine the title one will be taken to by a "Go" search, if any'
  83                 );
  84         }
  85
  86         public function getPossibleErrors() {
  87                 return array_merge( parent::getPossibleErrors(), array(
  88                         array( 'missingparam', 'text' )
  89                 ) );
  90         }
  91
  92         protected function getExamples() {
  93                 return array(
  94                         'api.php?action=go&text=Foo'
  95                 );
  96         }
  97
  98         public function getVersion() {
  99                 return __CLASS__ . ': $Id$';
 100         }
 101 }