This is a three-in-one module to query: * backlinks - links pointing to the given page, * embeddedin - what pages transclude the given page within themselves, * imageusage - what pages use the given image. More...

Inheritance diagram for ApiQueryBacklinks:

[legend]

Collaboration diagram for ApiQueryBacklinks:

[legend]

List of all members.

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 ()
	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.
Public Attributes
	$bl_code
	$bl_fields
	$bl_from
	$bl_table
	$bl_title
	$contID
	$hasNS
	$redirect
	$redirID
Protected Member Functions
	getContinueRedirStr ($lastPageID, $lastRedirID)
	getContinueStr ($lastPageID)
	parseContinueParam ()
	processContinue ()
Private Member Functions
	extractRedirRowInfo ($row)
	extractRowInfo ($row)
	prepareFirstQuery ($resultPageSet=null)
	prepareSecondQuery ($resultPageSet=null)
	run ($resultPageSet=null)
Private Attributes
	$backlinksSettings
	$bl_ns
	$continueStr = null
array	$pageMap = array()
	Maps ns and title to pageid.
	$params
	$redirTitles = array()
	$resultArr
Title	$rootTitle

Detailed Description

This is a three-in-one module to query: * backlinks - links pointing to the given page, * embeddedin - what pages transclude the given page within themselves, * imageusage - what pages use the given image.

Definition at line 35 of file ApiQueryBacklinks.php.

Constructor & Destructor Documentation

ApiQueryBacklinks::__construct	(	$	query,
		$	moduleName
	)

Definition at line 76 of file ApiQueryBacklinks.php.

Member Function Documentation

ApiQueryBacklinks::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 104 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::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 112 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::extractRedirRowInfo ( $ row ) [private]

Definition at line 370 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::extractRowInfo ( $ row ) [private]

Definition at line 357 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::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 443 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::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 108 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::getContinueRedirStr	(	$	lastPageID,
		$	lastRedirID
	)		`[protected]`

Definition at line 439 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::getContinueStr ( $ lastPageID ) [protected]

Definition at line 433 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 518 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 541 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::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 560 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::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 486 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 531 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::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 507 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::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 564 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::parseContinueParam ( ) [protected]

Definition at line 396 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::prepareFirstQuery ( $ resultPageSet = null ) [private]

Parameters:

$resultPageSet ApiPageSet

Returns:: void

Definition at line 120 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::prepareSecondQuery ( $ resultPageSet = null ) [private]

Parameters:

$resultPageSet ApiPageSet

Returns:: void

Definition at line 164 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::processContinue ( ) [protected]

Definition at line 383 of file ApiQueryBacklinks.php.

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

Parameters:

$resultPageSet ApiPageSet

Returns:: void

Definition at line 243 of file ApiQueryBacklinks.php.

Member Data Documentation

ApiQueryBacklinks::$backlinksSettings [private]

Initial value:

 array(
                'backlinks' => array(
                        'code' => 'bl',
                        'prefix' => 'pl',
                        'linktbl' => 'pagelinks',
                        'helpurl' => 'https://www.mediawiki.org/wiki/API:Backlinks',
                ),
                'embeddedin' => array(
                        'code' => 'ei',
                        'prefix' => 'tl',
                        'linktbl' => 'templatelinks',
                        'helpurl' => 'https://www.mediawiki.org/wiki/API:Embeddedin',
                ),
                'imageusage' => array(
                        'code' => 'iu',
                        'prefix' => 'il',
                        'linktbl' => 'imagelinks',
                        'helpurl' => 'https://www.mediawiki.org/wiki/API:Imageusage',
                )
        )

Definition at line 55 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_code

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_fields

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_from

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_ns [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_table

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_title

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$contID

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$continueStr = null [private]

Definition at line 52 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$hasNS

Definition at line 42 of file ApiQueryBacklinks.php.

array ApiQueryBacklinks::$pageMap = array() [private]

Maps ns and title to pageid.

Definition at line 48 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$params [private]

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$redirect

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$redirID

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$redirTitles = array() [private]

Definition at line 51 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$resultArr [private]

Definition at line 49 of file ApiQueryBacklinks.php.

Title ApiQueryBacklinks::$rootTitle [private]

Definition at line 39 of file ApiQueryBacklinks.php.

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

includes/api/ApiQueryBacklinks.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation