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 ()
	getVersion ()
	Returns a string that identifies the version of the extending class.
Public Attributes
	$bl_code
	$bl_fields
	$bl_from
	$bl_sort
	$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
	$pageMap = array()
	$params
	$redirTitles = array()
	$resultArr
	$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 78 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 108 of file ApiQueryBacklinks.php.

References run().

Here is the call graph for this function:

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

References run().

Here is the call graph for this function:

ApiQueryBacklinks::extractRedirRowInfo ( $ row ) [private]

Definition at line 355 of file ApiQueryBacklinks.php.

References ApiQueryBase\addTitleInfo(), ApiBase\getResult(), and Title\makeTitle().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQueryBacklinks::extractRowInfo ( $ row ) [private]

Definition at line 342 of file ApiQueryBacklinks.php.

References $t, ApiQueryBase\addTitleInfo(), and Title\makeTitle().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Reimplemented from ApiBase.

Definition at line 435 of file ApiQueryBacklinks.php.

References ApiBase\getModuleName(), ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

Here is the call graph for this function:

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

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

Definition at line 431 of file ApiQueryBacklinks.php.

References getContinueStr().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQueryBacklinks::getContinueStr ( $ lastPageID ) [protected]

Definition at line 425 of file ApiQueryBacklinks.php.

Referenced by getContinueRedirStr(), and run().

Here is the caller graph for this function:

ApiQueryBacklinks::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 488 of file ApiQueryBacklinks.php.

References ApiBase\dieDebug(), and ApiBase\getModuleName().

Here is the call graph for this function:

ApiQueryBacklinks::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 509 of file ApiQueryBacklinks.php.

References ApiBase\getModuleName().

Here is the call graph for this function:

ApiQueryBacklinks::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 528 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 or false

Reimplemented from ApiBase.

Definition at line 469 of file ApiQueryBacklinks.php.

References ApiBase\getModuleName().

Here is the call graph for this function:

ApiQueryBacklinks::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 501 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 532 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::parseContinueParam ( ) [protected]

Definition at line 388 of file ApiQueryBacklinks.php.

References $contID, $redirID, ApiBase\dieUsage(), and Title\makeTitleSafe().

Referenced by processContinue().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters:

$resultPageSet ApiPageSet

Returns:: void

Definition at line 124 of file ApiQueryBacklinks.php.

References ApiQueryBase\addFields(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addWhere(), and ApiQueryBase\addWhereFld().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters:

$resultPageSet ApiPageSet

Returns:: void

Definition at line 166 of file ApiQueryBacklinks.php.

References $t, $title, ApiQueryBase\addFields(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), and ApiQueryBase\getDB().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiQueryBacklinks::processContinue ( ) [protected]

Definition at line 368 of file ApiQueryBacklinks.php.

References $title, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), Title\newFromText(), and parseContinueParam().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters:

$resultPageSet ApiPageSet

Returns:: void

Definition at line 228 of file ApiQueryBacklinks.php.

References $count, $res, $result, extractRedirRowInfo(), ApiBase\extractRequestParams(), extractRowInfo(), getContinueRedirStr(), getContinueStr(), ApiBase\getMain(), ApiBase\getModuleName(), ApiBase\getResult(), ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, Title\makeTitle(), prepareFirstQuery(), prepareSecondQuery(), processContinue(), ApiQueryBase\resetQueryParams(), ApiQueryBase\select(), and ApiQueryBase\setContinueEnumParameter().

Referenced by execute(), and executeGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

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

ApiQueryBacklinks::$bl_code

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_fields

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_from

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_ns [private]

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_sort

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_table

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_title

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$contID

Definition at line 42 of file ApiQueryBacklinks.php.

Referenced by parseContinueParam().

ApiQueryBacklinks::$continueStr = null [private]

Definition at line 54 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$hasNS

Definition at line 43 of file ApiQueryBacklinks.php.

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

Definition at line 50 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$params [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$redirect

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$redirID

Definition at line 42 of file ApiQueryBacklinks.php.

Referenced by parseContinueParam().

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

Definition at line 53 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$resultArr [private]

Definition at line 51 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$rootTitle [private]

Definition at line 40 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