34592ad7af012563e6936076541c9eb2848ef6df
4 * Created on Mar 30, 2010
5 * API for MediaWiki 1.8+
7 * Copyright © 2010 Matthew Britton <Firstname>.<Lastname>@btinternet.com
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.
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.
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
25 if ( !defined( 'MEDIAWIKI' ) ) {
26 // Eclipse helper - will be ignored in production
27 require_once( "ApiBase.php" );
31 * API module to determine the result of a "Go" search
35 class ApiGo
extends ApiBase
{
36 public function __construct( $main, $action ) {
37 parent
::__construct( $main, $action );
40 public function execute() {
41 $params = $this->extractRequestParams();
42 $text = $params['text'];
44 if ( is_null( $text ) ) {
45 $this->dieUsageMsg( array( 'missingparam', 'text' ) );
49 $text = str_replace( '_', ' ', $text );
51 $nearMatch = SearchEngine
::getNearMatch( $text );
53 $this->getResult()->addValue( null, $this->getModuleName(), array( 'text' => $text, 'result' => $nearMatch ) );
56 public function mustBePosted() {
60 public function isWriteMode() {
64 public function getAllowedParams() {
70 public function getParamDescription() {
72 'text' => 'Text to try a "Go" match for'
76 public function getDescription() {
77 return 'Determine the title one will be taken to by a "Go" search, if any';
80 public function getPossibleErrors() {
81 return array_merge( parent
::getPossibleErrors(), array(
82 array( 'missingparam', 'text' )
86 protected function getExamples() {
88 'api.php?action=go&text=Foo'
92 public function getVersion() {
93 return __CLASS__
. ': $Id$';