Query module to enumerate links from all pages together. More...

Inheritance diagram for ApiQueryAllLinks:

Collaboration diagram for ApiQueryAllLinks:

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.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	getVersion ()
	Returns a string that identifies the version of the extending class.
Private Member Functions
	run ($resultPageSet=null)

Detailed Description

Query module to enumerate links from all pages together.

Definition at line 32 of file ApiQueryAllLinks.php.

Constructor & Destructor Documentation

ApiQueryAllLinks::__construct	(	$	query,
		$	moduleName
	)

Definition at line 34 of file ApiQueryAllLinks.php.

Member Function Documentation

ApiQueryAllLinks::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 38 of file ApiQueryAllLinks.php.

References run().

Here is the call graph for this function:

ApiQueryAllLinks::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 46 of file ApiQueryAllLinks.php.

References run().

Here is the call graph for this function:

ApiQueryAllLinks::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 or false

Reimplemented from ApiBase.

Definition at line 158 of file ApiQueryAllLinks.php.

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

ApiQueryAllLinks::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 42 of file ApiQueryAllLinks.php.

ApiQueryAllLinks::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 205 of file ApiQueryAllLinks.php.

ApiQueryAllLinks::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 219 of file ApiQueryAllLinks.php.

ApiQueryAllLinks::getHelpUrls ( )

Returns:: false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 225 of file ApiQueryAllLinks.php.

ApiQueryAllLinks::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 or false

Reimplemented from ApiBase.

Definition at line 187 of file ApiQueryAllLinks.php.

References ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiQueryAllLinks::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 209 of file ApiQueryAllLinks.php.

References ApiBase\getModuleName().

Here is the call graph for this function:

ApiQueryAllLinks::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 229 of file ApiQueryAllLinks.php.

ApiQueryAllLinks::run ( $ resultPageSet = null ) [private]

Parameters:

$resultPageSet ApiPageSet

Returns:: void

Definition at line 54 of file ApiQueryAllLinks.php.

References $count, $limit, $res, $result, $title, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTitleInfo(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereRange(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), ApiQueryBase\getDB(), ApiBase\getModuleName(), ApiBase\getResult(), ApiQueryBase\keyToTitle(), Title\makeTitle(), ApiQueryBase\select(), ApiQueryBase\setContinueEnumParameter(), ApiQueryBase\titlePartToKey(), and ApiQueryBase\titleToKey().

Referenced by execute(), and executeGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

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

includes/api/ApiQueryAllLinks.php

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation