This is the main API class, used for both external and internal processing. More...

Inheritance diagram for ApiMain:

Collaboration diagram for ApiMain:

Public Member Functions
	__construct ($context=null, $enableWrite=false)
	Constructs an instance of ApiMain that utilizes the module and format specified by $request.
	canApiHighLimits ()
	Check whether the current user is allowed to use high limits.
	createPrinterByName ($format)
	Create an instance of an output formatter by its name.
	execute ()
	Execute api request.
	getAllowedParams ()
	See ApiBase for description.
	getDescription ()
	See ApiBase for description.
	getFormats ()
	Returns the list of supported formats in form ( 'format' => 'ClassName' )
	getModule ()
	Get the API module object.
	getModules ()
	Get the array mapping module names to class names.
	getParamDescription ()
	See ApiBase for description.
	getPossibleErrors ()
	getPrinter ()
	Get the result formatter object.
	getResult ()
	Get the ApiResult object associated with current request.
	getShowVersions ()
	Check whether the user wants us to show version information in the API help.
	getVersion ()
	Returns the version information of this file, plus it includes the versions for all files that are not callable proper API modules.
	isInternalMode ()
	Return true if the API was started by other PHP code using FauxRequest.
	isReadMode ()
	makeHelpMsg ()
	Override the parent to generate help messages for all available modules.
	reallyMakeHelpMsg ()
	setCacheControl ($directives)
	Set directives (key/value pairs) for the Cache-Control header.
	setCacheMaxAge ($maxage)
	Set how long the response should be cached.
	setCacheMode ($mode)
	Set the type of caching headers which will be sent.
	setCachePrivate ()
	setHelp ($help=true)
	Sets whether the pretty-printer should format bold and $italics$.
	setVaryCookie ()
	Make sure Vary: Cookie and friends are set.
Static Public Member Functions
static	makeHelpMsgHeader ($module, $paramName)
Public Attributes
	$mAction
	$mEnableWrite
	$mFormatNames
	$mFormats
	$mModule
	$mModuleNames
	$mShowVersions
	$mSquidMaxage
const	API_DEFAULT_FORMAT = 'xmlfm'
	When no format parameter is given, this format will be used.
Protected Member Functions
	addFormat ($fmtName, $fmtClass)
	Add or overwrite an output format for this ApiMain.
	addModule ($mdlName, $mdlClass)
	Add or overwrite a module in this ApiMain instance.
	checkExecutePermissions ($module)
	Check for sufficient permissions to execute.
	checkMaxLag ($module, $params)
	Check the max lag if necessary.
	executeAction ()
	Execute the actual module, without any error handling.
	executeActionWithErrorHandling ()
	Execute an action, and in case of an error, erase whatever partial results have been accumulated, and replace it with an error message and a help screen.
	getCredits ()
	Returns an array of strings with credits for the API.
	handleCORS ()
	Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.
	printResult ($isError)
	Print results using the current printer.
	sendCacheHeaders ()
	setupExecuteAction ()
	Set up for the execution.
	setupExternalResponse ($module, $params)
	Check POST for external response and setup result printer.
	setupModule ()
	Set up the module for response.
	substituteResultWithError ($e)
	Replace the result data with the information about an exception.
Static Protected Member Functions
static	matchOrigin ($value, $rules, $exceptions)
	Attempt to match an Origin header against a set of rules and a set of exceptions.
static	wildcardToRegex ($wildcard)
	Helper function to convert wildcard string into a regex '*' => '.
Private Attributes
	$mCacheControl = array()
	$mCacheMode = 'private'
	$mCanApiHighLimits = null
	$mInternalMode
	$mModules
ApiFormatBase	$mPrinter
	$mResult
Static Private Attributes
static	$Formats
	List of available formats: format name => format class.
static	$Modules
	List of available modules: action name => module class.
static	$mRights
	List of user roles that are specifically relevant to the API.

Detailed Description

This is the main API class, used for both external and internal processing.

When executed, it will create the requested formatter object, instantiate and execute an object associated with the needed action, and use formatter to print results. In case of an exception, an error message will be printed using the same formatter.

To use API from another application, run it using FauxRequest object, in which case any internal exceptions will not be handled but passed up to the caller. After successful execution, use getResult() for the resulting data.

Definition at line 41 of file ApiMain.php.

Constructor & Destructor Documentation

ApiMain::__construct	(	$	context = `null`,
		$	enableWrite = `false`
	)

Constructs an instance of ApiMain that utilizes the module and format specified by $request.

Parameters:

$context	IContextSource\|WebRequest - if this is an instance of FauxRequest, errors are thrown and no printing occurs
$enableWrite	bool should be set to true if the api may modify data

Definition at line 144 of file ApiMain.php.

Member Function Documentation

ApiMain::addFormat	(	$	fmtName,
		$	fmtClass
	)		`[protected]`

Add or overwrite an output format for this ApiMain.

Intended for use by extending classes who wish to add to or modify current formatters.

Parameters:

$fmtName	string The identifier for this format.
$fmtClass	ApiFormatBase The class implementing this format.

Definition at line 1147 of file ApiMain.php.

ApiMain::addModule	(	$	mdlName,
		$	mdlClass
	)		`[protected]`

Add or overwrite a module in this ApiMain instance.

Intended for use by extending classes who wish to add their own modules to their lexicon or override the behavior of inherent ones.

Parameters:

$mdlName	String The identifier for this module.
$mdlClass	String The class where this module is implemented.

Definition at line 1136 of file ApiMain.php.

ApiMain::canApiHighLimits ( )

Check whether the current user is allowed to use high limits.

Returns:: bool

Definition at line 1096 of file ApiMain.php.

ApiMain::checkExecutePermissions ( $ module ) [protected]

Check for sufficient permissions to execute.

Parameters:

$module ApiBase An Api module

Definition at line 745 of file ApiMain.php.

ApiMain::checkMaxLag	(	$	module,
		$	params
	)		`[protected]`

Check the max lag if necessary.

Parameters:

$module	ApiBase object: Api module being used
$params	Array an array containing the request parameters.

Returns:: boolean True on success, false should exit immediately

Definition at line 718 of file ApiMain.php.

ApiMain::createPrinterByName ( $ format )

Create an instance of an output formatter by its name.

Parameters:

$format string

Returns:: ApiFormatBase

Definition at line 331 of file ApiMain.php.

ApiMain::execute ( )

Execute api request.

Any errors will be handled if the API was called by the remote client.

Reimplemented from ApiBase.

Definition at line 341 of file ApiMain.php.

ApiMain::executeAction ( ) [protected]

Execute the actual module, without any error handling.

Definition at line 797 of file ApiMain.php.

ApiMain::executeActionWithErrorHandling ( ) [protected]

Execute an action, and in case of an error, erase whatever partial results have been accumulated, and replace it with an error message and a help screen.

Definition at line 356 of file ApiMain.php.

ApiMain::getAllowedParams ( )

See ApiBase for description.

Returns:: array

Reimplemented from ApiBase.

Definition at line 863 of file ApiMain.php.

ApiMain::getCredits ( ) [protected]

Returns an array of strings with credits for the API.

Returns:: array

Definition at line 983 of file ApiMain.php.

ApiMain::getDescription ( )

See ApiBase for description.

Returns:: array

Reimplemented from ApiBase.

Definition at line 927 of file ApiMain.php.

ApiMain::getFormats ( )

Returns the list of supported formats in form ( 'format' => 'ClassName' )

Since:: 1.18

Returns:: array

Definition at line 1165 of file ApiMain.php.

ApiMain::getModule ( )

Get the API module object.

Only works after executeAction()

Returns:: ApiBase

Definition at line 216 of file ApiMain.php.

ApiMain::getModules ( )

Get the array mapping module names to class names.

Returns:: array

Definition at line 1155 of file ApiMain.php.

ApiMain::getParamDescription ( )

See ApiBase for description.

Returns:: array

Reimplemented from ApiBase.

Definition at line 896 of file ApiMain.php.

ApiMain::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiBase.

Definition at line 969 of file ApiMain.php.

ApiMain::getPrinter ( )

Get the result formatter object.

Only works after setupExecuteAction()

Returns:: ApiFormatBase

Definition at line 225 of file ApiMain.php.

ApiMain::getResult ( )

Get the ApiResult object associated with current request.

Returns:: ApiResult

Reimplemented from ApiBase.

Definition at line 207 of file ApiMain.php.

ApiMain::getShowVersions ( )

Check whether the user wants us to show version information in the API help.

Returns:: bool

Definition at line 1108 of file ApiMain.php.

ApiMain::getVersion ( )

Returns the version information of this file, plus it includes the versions for all files that are not callable proper API modules.

Returns:: array

Reimplemented from ApiBase.

Definition at line 1118 of file ApiMain.php.

ApiMain::handleCORS ( ) [protected]

Check the &origin= query parameter against the Origin: HTTP header and respond appropriately.

If no origin parameter is present, nothing happens. If an origin parameter is present but doesn't match the Origin header, a 403 status code is set and false is returned. If the parameter and the header do match, the header is checked against $wgCrossSiteAJAXdomains and $wgCrossSiteAJAXdomainExceptions, and if the origin qualifies, the appropriate CORS headers are set.

Returns:: bool False if the caller should abort (403 case), true otherwise (all other cases)

Definition at line 426 of file ApiMain.php.

ApiMain::isInternalMode ( )

Return true if the API was started by other PHP code using FauxRequest.

Returns:: bool

Definition at line 198 of file ApiMain.php.

ApiMain::isReadMode ( )

Returns:: bool

Reimplemented from ApiBase.

Definition at line 854 of file ApiMain.php.

ApiMain::makeHelpMsg ( )

Override the parent to generate help messages for all available modules.

Returns:: string

Reimplemented from ApiBase.

Definition at line 1011 of file ApiMain.php.

static ApiMain::makeHelpMsgHeader	(	$	module,
		$	paramName
	)		`[static]`

Parameters:

$module	ApiBase
$paramName	String What type of request is this? e.g. action, query, list, prop, meta, format

Returns:: string

Definition at line 1081 of file ApiMain.php.

Referenced by ApiHelp\buildModuleHelp().

static ApiMain::matchOrigin	(	$	value,
		$	rules,
		$	exceptions
	)		`[static, protected]`

Attempt to match an Origin header against a set of rules and a set of exceptions.

Parameters:

$value	string Origin header
$rules	array Set of wildcard rules
$exceptions	array Set of wildcard rules

Returns:: bool True if $value matches a rule in $rules and doesn't match any rules in $exceptions, false otherwise

Definition at line 468 of file ApiMain.php.

ApiMain::printResult ( $ isError ) [protected]

Print results using the current printer.

Parameters:

$isError bool

Definition at line 831 of file ApiMain.php.

ApiMain::reallyMakeHelpMsg ( )

Returns:: mixed|string

Definition at line 1034 of file ApiMain.php.

ApiMain::sendCacheHeaders ( ) [protected]

Definition at line 501 of file ApiMain.php.

References $out, $response, $value, ContextSource\getOutput(), ApiBase\getParameter(), ContextSource\getRequest(), and wfTimestamp().

ApiMain::setCacheControl ( $ directives )

Set directives (key/value pairs) for the Cache-Control header.

Boolean values will be formatted as such, by including or omitting without an equals sign.

Cache control values set here will only be used if the cache mode is not private, see setCacheMode().

Parameters:

$directives array

Definition at line 305 of file ApiMain.php.

ApiMain::setCacheMaxAge ( $ maxage )

Set how long the response should be cached.

Parameters:

$maxage

Definition at line 234 of file ApiMain.php.

ApiMain::setCacheMode ( $ mode )

Set the type of caching headers which will be sent.

Parameters:

$mode

String One of:

'public': Cache this object in public caches, if the maxage or smaxage parameter is set, or if setCacheMaxAge() was called. If a maximum age is not provided by any of these means, the object will be private.
'private': Cache this object only in private client-side caches.
'anon-public-user-private': Make this object cacheable for logged-out users, but private for logged-in users. IMPORTANT: If this is set, it must be set consistently for a given URL, it cannot be set differently depending on things like the contents of the database, or whether the user is logged in.

If the wiki does not allow anonymous users to read it, the mode set here will be ignored, and private caching headers will always be sent. In other words, the "public" mode is equivalent to saying that the data sent is as public as a page view.

For user-dependent data, the private mode should generally be used. The anon-public-user-private mode should only be used where there is a particularly good performance reason for caching the anonymous response, but where the response to logged-in users may differ, or may contain private data.

If this function is never called, then the default will be the private mode.

Definition at line 266 of file ApiMain.php.

ApiMain::setCachePrivate ( )

Deprecated:: since 1.17 Private caching is now the default, so there is usually no need to call this function.

If there is a need, you can use $this->setCacheMode('private')

Definition at line 290 of file ApiMain.php.

ApiMain::setHelp ( $ help = true )

Sets whether the pretty-printer should format *bold* and $italics$.

Parameters:

$help bool

Definition at line 1002 of file ApiMain.php.

ApiMain::setupExecuteAction ( ) [protected]

Set up for the execution.

Returns:: array

Definition at line 652 of file ApiMain.php.

ApiMain::setupExternalResponse	(	$	module,
		$	params
	)		`[protected]`

Check POST for external response and setup result printer.

Parameters:

$module	ApiBase An Api module
$params	Array an array with the request parameters

Definition at line 776 of file ApiMain.php.

ApiMain::setupModule ( ) [protected]

Set up the module for response.

Returns:: ApiBase The module that will handle this action

Definition at line 685 of file ApiMain.php.

ApiMain::setVaryCookie ( )

Make sure Vary: Cookie and friends are set.

Use this when the output of a request may be cached for anons but may not be cached for logged-in users.

WARNING: This function must be called CONSISTENTLY for a given URL. This means that a given URL must either always or never call this function; if it sometimes does and sometimes doesn't, stuff will break.

Deprecated:: since 1.17 Use setCacheMode( 'anon-public-user-private' )

Definition at line 319 of file ApiMain.php.

ApiMain::substituteResultWithError ( $ e ) [protected]

Replace the result data with the information about an exception.

Returns the error code

Parameters:

$e Exception

Returns:: string

Definition at line 587 of file ApiMain.php.

static ApiMain::wildcardToRegex ( $ wildcard ) [static, protected]

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

*?' '?' => '.'

Parameters:

$wildcard string String with wildcards

Returns:: string Regular expression

Definition at line 491 of file ApiMain.php.

Member Data Documentation

ApiMain::$Formats [static, private]

Initial value:

 array(
                'json' => 'ApiFormatJson',
                'jsonfm' => 'ApiFormatJson',
                'php' => 'ApiFormatPhp',
                'phpfm' => 'ApiFormatPhp',
                'wddx' => 'ApiFormatWddx',
                'wddxfm' => 'ApiFormatWddx',
                'xml' => 'ApiFormatXml',
                'xmlfm' => 'ApiFormatXml',
                'yaml' => 'ApiFormatYaml',
                'yamlfm' => 'ApiFormatYaml',
                'rawfm' => 'ApiFormatJson',
                'txt' => 'ApiFormatTxt',
                'txtfm' => 'ApiFormatTxt',
                'dbg' => 'ApiFormatDbg',
                'dbgfm' => 'ApiFormatDbg',
                'dump' => 'ApiFormatDump',
                'dumpfm' => 'ApiFormatDump',
        )

List of available formats: format name => format class.

Definition at line 90 of file ApiMain.php.

ApiMain::$mAction

Definition at line 132 of file ApiMain.php.

ApiMain::$mCacheControl = array() [private]

Definition at line 136 of file ApiMain.php.

ApiMain::$mCacheMode = 'private' [private]

Definition at line 135 of file ApiMain.php.

ApiMain::$mCanApiHighLimits = null [private]

Definition at line 1090 of file ApiMain.php.

ApiMain::$mEnableWrite

Definition at line 132 of file ApiMain.php.

ApiMain::$mFormatNames

Definition at line 131 of file ApiMain.php.

ApiMain::$mFormats

Definition at line 131 of file ApiMain.php.

ApiMain::$mInternalMode [private]

Definition at line 133 of file ApiMain.php.

ApiMain::$mModule

Definition at line 133 of file ApiMain.php.

ApiMain::$mModuleNames

Definition at line 131 of file ApiMain.php.

ApiMain::$mModules [private]

Definition at line 131 of file ApiMain.php.

ApiMain::$Modules [static, private]

List of available modules: action name => module class.

Definition at line 51 of file ApiMain.php.

ApiFormatBase ApiMain::$mPrinter [private]

Definition at line 129 of file ApiMain.php.

ApiMain::$mResult [private]

Definition at line 132 of file ApiMain.php.

ApiMain::$mRights [static, private]

Initial value:

 array(
                'writeapi' => array(
                        'msg' => 'Use of the write API',
                        'params' => array()
                ),
                'apihighlimits' => array(
                        'msg' => 'Use higher limits in API queries (Slow queries: $1 results; Fast queries: $2 results). The limits for slow queries also apply to multivalue parameters.',
                        'params' => array( ApiBase::LIMIT_SML2, ApiBase::LIMIT_BIG2 )
                )
        )

List of user roles that are specifically relevant to the API.

array( 'right' => array ( 'msg' => 'Some message with a $1', 'params' => array ( $someVarToSubst ) ), );

Definition at line 116 of file ApiMain.php.

ApiMain::$mShowVersions

Definition at line 132 of file ApiMain.php.

ApiMain::$mSquidMaxage

Definition at line 133 of file ApiMain.php.

const ApiMain::API_DEFAULT_FORMAT = 'xmlfm'

When no format parameter is given, this format will be used.

Definition at line 46 of file ApiMain.php.

The documentation for this class was generated from the following file:

includes/api/ApiMain.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation