Query module to get the results of a QueryPage-based special page. More...

Inheritance diagram for ApiQueryQueryPage:

Collaboration diagram for ApiQueryQueryPage:

Public Member Functions
	__construct ($query, $moduleName)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	executeGenerator ($resultPageSet)
	Execute this module as a generator.
	getAllowedParams ()
	Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
	getCacheMode ($params)
	Get the cache mode for the data generated by this module.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
	getVersion ()
	Returns a string that identifies the version of the extending class.
	run ($resultPageSet=null)
Private Attributes
	$qpMap
	$uselessQueryPages
	Some query pages are useless because they're available elsewhere in the API.

Detailed Description

Query module to get the results of a QueryPage-based special page.

Definition at line 32 of file ApiQueryQueryPage.php.

Constructor & Destructor Documentation

ApiQueryQueryPage::__construct	(	$	query,
		$	moduleName
	)

Definition at line 44 of file ApiQueryQueryPage.php.

References $IP, $page, and $wgQueryPages.

Member Function Documentation

ApiQueryQueryPage::execute ( )

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 61 of file ApiQueryQueryPage.php.

References run().

ApiQueryQueryPage::executeGenerator ( $ resultPageSet )

Execute this module as a generator.

Parameters:

$resultPageSet ApiPageSet: All output should be appended to this object

Reimplemented from ApiQueryGeneratorBase.

Definition at line 65 of file ApiQueryQueryPage.php.

References run().

ApiQueryQueryPage::getAllowedParams ( )

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Returns:: array|bool

Reimplemented from ApiBase.

Definition at line 151 of file ApiQueryQueryPage.php.

References ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\PARAM_DFLT, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

ApiQueryQueryPage::getCacheMode ( $ params )

Get the cache mode for the data generated by this module.

Override this in the module subclass. For possible return values and other details about cache modes, see ApiMain::setCacheMode()

Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.

Parameters:

$params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 143 of file ApiQueryQueryPage.php.

References $params.

ApiQueryQueryPage::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 208 of file ApiQueryQueryPage.php.

ApiQueryQueryPage::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 218 of file ApiQueryQueryPage.php.

ApiQueryQueryPage::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 168 of file ApiQueryQueryPage.php.

ApiQueryQueryPage::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 212 of file ApiQueryQueryPage.php.

ApiQueryQueryPage::getResultProperties ( )

Returns possible properties in the result, grouped by the value of the prop parameter that shows them.

Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.

Don't call this functon directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no properties

Reimplemented from ApiBase.

Definition at line 176 of file ApiQueryQueryPage.php.

References ApiBase\PROP_NULLABLE, ApiBase\PROP_ROOT, and ApiBase\PROP_TYPE.

ApiQueryQueryPage::getVersion ( )

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:: string

Reimplemented from ApiBase.

Definition at line 224 of file ApiQueryQueryPage.php.

ApiQueryQueryPage::run ( $ resultPageSet = null )

Parameters:

$resultPageSet ApiPageSet

Definition at line 72 of file ApiQueryQueryPage.php.

References $count, $params, $res, $result, $title, $value, ApiQueryBase\addTitleInfo(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), Title\makeTitle(), ApiQueryBase\setContinueEnumParameter(), and wfTimestamp().

Referenced by execute(), and executeGenerator().

Member Data Documentation

ApiQueryQueryPage::$qpMap [private]

Definition at line 33 of file ApiQueryQueryPage.php.

ApiQueryQueryPage::$uselessQueryPages [private]

Initial value:

 array(
                'MIMEsearch', 
                'LinkSearch', 
                'FileDuplicateSearch', 
        )

Some query pages are useless because they're available elsewhere in the API.

Definition at line 38 of file ApiQueryQueryPage.php.

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

includes/api/ApiQueryQueryPage.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation