api.php File Reference

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

Go to the source code of this file.

Enumerations
enum	MW_API
Variables
	$endtime = microtime( true )
if($wgAPIRequestLog)	$lb = wfGetLBFactory()
	$processor = new ApiMain( RequestContext::getMain(), $wgEnableWriteAPI )
	$starttime = microtime( true )
if(!$wgRequest-> checkUrlExtension()) if(!$wgEnableAPI)	$wgTitle = Title::makeTitle( NS_MAIN, 'API' )

---

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 sepecified 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.

---

Enumeration Type Documentation

enum MW_API

Definition at line 34 of file api.php.

---

Variable Documentation

$endtime = microtime( true )

Definition at line 83 of file api.php.

if ($wgAPIRequestLog) $lb = wfGetLBFactory()

Definition at line 108 of file api.php.

Referenced by ApiQuerySiteinfo\appendDbReplLagInfo(), nextJobDB\checkJob(), RefreshLinks\deleteLinksFromNonexistent(), SpecialExport\doExport(), UserCache\doQuery(), GetLagTimes\execute(), GetSlaveServer\execute(), ApiSetNotificationTimestamp\execute(), ApiQueryDeletedrevs\execute(), DatabaseLag\execute(), TrackBlobs\findOrphanBlobs(), LBFactory_Multi\forEachLB(), OrphanStats\getDB(), RecompressTracked\getExtDB(), LBFactory_Multi\getMainLB(), ExternalStoreDB\getMaster(), nextJobDB\getPendingDbs(), ApiQueryInfo\getProtectionInfo(), ApiPageSet\getRedirectTargets(), ExternalStoreDB\getSlave(), ProtectedTitlesPager\getStartBody(), LogPager\getStartBody(), ProtectedPagesPager\getStartBody(), ApiQueryInfo\getTSIDs(), ApiQueryInfo\getWatchedInfo(), SpecialEditWatchlist\getWatchlistInfo(), LBFactory_Multi\newLoadBalancer(), Skin\preloadExistence(), BlockListPager\preprocessResults(), ApiQueryLinks\run(), LBFactory_Multi\shutdown(), RecompressTracked\waitForSlaves(), and wfWaitForSlaves().

$processor = new ApiMain( RequestContext::getMain(), $wgEnableWriteAPI )

Definition at line 74 of file api.php.

$starttime = microtime( true )

Definition at line 51 of file api.php.

if (!$wgRequest->checkUrlExtension()) if (!$wgEnableAPI) $wgTitle = Title::makeTitle( NS_MAIN, 'API' )

Definition at line 68 of file api.php.

Referenced by SrConverter\autoConvert(), ShiConverter\autoConvert(), IuConverter\autoConvert(), KuConverter\autoConvert(), KkConverter\autoConvert(), SpecialPageFactory\capturePath(), ApiParse\execute(), ApiEditPage\execute(), EditCLI\execute(), Orphans\execute(), RebuildFileCache\execute(), RebuildTextIndex\execute(), NamespaceConflictChecker\execute(), RunJobs\execute(), CommandLineInstaller\execute(), UpdateMediaWiki\execute(), MediaWiki\main(), and Parser\transformMsg().