api.php File Reference

API for MediaWiki 1.8+. More...

Go to the source code of this file.

Enumerations
enum	MW_API
	This file is the entry point for all API queries. More...
Functions
if(!$wgRequest-> checkUrlExtension()) if(!$wgEnableAPI)	convertWildcard ($search)
	Helper function to convert wildcard string into a regex '*' => '.
Variables
	$endtime = microtime( true )
if($wgAPIRequestLog)	$lb = wfGetLBFactory()
	$processor = new ApiMain( $wgRequest, $wgEnableWriteAPI )
	$starttime = microtime( true )
if($wgCrossSiteAJAXdomains &&isset($_SERVER['HTTP_ORIGIN']))	$wgTitle = Title::makeTitle( NS_MAIN, 'API' )

---

Detailed Description

API for MediaWiki 1.8+.

Copyright (C) 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

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.

Definition at line 38 of file api.php.

---

Function Documentation

if (!$wgRequest->checkUrlExtension()) if (!$wgEnableAPI) convertWildcard

(

$

search

)

Helper function to convert wildcard string into a regex '*' => '.

*?' '?' => '.'

Parameters:

$search

string

Returns:

string

Definition at line 79 of file api.php.

---

Variable Documentation

$endtime = microtime( true )

Definition at line 123 of file api.php.

if ($wgAPIRequestLog) $lb = wfGetLBFactory()

Definition at line 148 of file api.php.

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

$processor = new ApiMain( $wgRequest, $wgEnableWriteAPI )

Definition at line 114 of file api.php.

$starttime = microtime( true )

Definition at line 54 of file api.php.

if ($wgCrossSiteAJAXdomains &&isset($_SERVER['HTTP_ORIGIN'])) $wgTitle = Title::makeTitle( NS_MAIN, 'API' )

Definition at line 108 of file api.php.

Referenced by WebRequest\appendQueryArray(), SrConverter\autoConvert(), ShiConverter\autoConvert(), IuConverter\autoConvert(), KuConverter\autoConvert(), KkConverter\autoConvert(), SpecialPageFactory\capturePath(), Parser\cleanSig(), ApiParse\execute(), EditCLI\execute(), ApiEditPage\execute(), Orphans\execute(), RebuildFileCache\execute(), RunJobs\execute(), NamespaceConflictChecker\execute(), RebuildTextIndex\execute(), CommandLineInstaller\execute(), UpdateMediaWiki\execute(), MWHttpRequest\execute(), Parser\extractSections(), DBConnectionError\fileCachedPage(), EditPage\getContextTitle(), RequestContext\getTitle(), MediaWiki\main(), MessageCache\parse(), MediaWiki\performRequest(), EditPage\spamPage(), and Parser\transformMsg().