MediaWiki  master
api.php File Reference

This file is the entry point for all API queries. More...

Go to the source code of this file.

Variables

if(!$processor instanceof
ApiMain) catch(Exception $e)
if($processor) 
$endtime = microtime( true )
 
if($wgAPIRequestLog) $mediawiki = new MediaWiki()
 
 $starttime = microtime( true )
 
if(!$wgRequest->
checkUrlExtension()) if(!$wgEnableAPI) 
$wgTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/dummy title for API calls set in api.php' )
 
const MW_API true
 
 try
 

Detailed Description

This file is the entry point for all API queries.

It begins by checking whether the API is enabled on this wiki; if not, it informs the user that s/he should set $wgEnableAPI to true and exits. Otherwise, it constructs a new ApiMain using the parameter passed to it as an argument in the URL ('?action=') and with write-enabled set to the value of $wgEnableWriteAPI as specified in LocalSettings.php. It then invokes "execute()" on the ApiMain object instance, which produces output in the format specified in the URL.

Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>.com

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition in file api.php.

Variable Documentation

if (!$processor instanceof ApiMain) catch (Exception $e) if ($processor) $endtime = microtime( true )

Definition at line 87 of file api.php.

if ($wgAPIRequestLog) $mediawiki = new MediaWiki()

Definition at line 117 of file api.php.

const MW_API true

Definition at line 36 of file api.php.

try
Initial value:
{
$wgEnableWriteAPI
Allow the API to be used to perform write operations (page edits, rollback, etc.) when an authorised ...
static getMain()
Static methods.
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:41

Definition at line 63 of file api.php.