A query module to list all wiki links on a given set of pages. More...

Inheritance diagram for ApiQueryLinks:

Collaboration diagram for ApiQueryLinks:

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.
	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
Public Attributes
	$description
	$helpUrl
	$prefix
const	LINKS = 'links'
const	TEMPLATES = 'templates'
Private Member Functions
	run ($resultPageSet=null)
Private Attributes
	$table

Detailed Description

A query module to list all wiki links on a given set of pages.

Definition at line 32 of file ApiQueryLinks.php.

Constructor & Destructor Documentation

ApiQueryLinks::__construct	(	$	query,
		$	moduleName
	)

Definition at line 39 of file ApiQueryLinks.php.

References $query, ApiBase\dieDebug(), and table.

Member Function Documentation

ApiQueryLinks::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 64 of file ApiQueryLinks.php.

References run().

ApiQueryLinks::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 72 of file ApiQueryLinks.php.

References run().

ApiQueryLinks::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.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns:: array|bool

Reimplemented from ApiBase.

Definition at line 186 of file ApiQueryLinks.php.

References array(), 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.

ApiQueryLinks::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 68 of file ApiQueryLinks.php.

ApiQueryLinks::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 233 of file ApiQueryLinks.php.

ApiQueryLinks::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 237 of file ApiQueryLinks.php.

References $name, array(), and ApiBase\getModuleName().

ApiQueryLinks::getHelpUrls ( )

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

Reimplemented from ApiBase.

Definition at line 247 of file ApiQueryLinks.php.

ApiQueryLinks::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this function 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 213 of file ApiQueryLinks.php.

References array().

ApiQueryLinks::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 function directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no properties

Reimplemented from ApiBase.

Definition at line 224 of file ApiQueryLinks.php.

References array().

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

Parameters:

$resultPageSet ApiPageSet

Returns:

Definition at line 80 of file ApiQueryLinks.php.

References $count, $lb, $params, $res, $sort, $t, $title, $titles, ApiQueryBase\addFields(), ApiQueryBase\addOption(), ApiQueryBase\addPageSubItem(), ApiQueryBase\addTables(), ApiQueryBase\addTitleInfo(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), array(), as, ApiBase\dieContinueUsageIf(), ApiBase\extractRequestParams(), ApiQueryBase\getDB(), ApiQueryGeneratorBase\getPageSet(), Title\makeTitle(), Title\newFromText(), ApiQueryBase\select(), ApiQueryGeneratorBase\setContinueEnumParameter(), ApiBase\setWarning(), and table.

Referenced by execute(), and executeGenerator().

Member Data Documentation

ApiQueryLinks::$description

Definition at line 37 of file ApiQueryLinks.php.

ApiQueryLinks::$helpUrl

Definition at line 37 of file ApiQueryLinks.php.

ApiQueryLinks::$prefix

Definition at line 37 of file ApiQueryLinks.php.

ApiQueryLinks::$table [private]

Definition at line 37 of file ApiQueryLinks.php.

const ApiQueryLinks::LINKS = 'links'

Definition at line 34 of file ApiQueryLinks.php.

const ApiQueryLinks::TEMPLATES = 'templates'

Definition at line 35 of file ApiQueryLinks.php.

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

includes/api/ApiQueryLinks.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation