ApiQueryBacklinks Class Reference
[API]

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

Inherits ApiQueryGeneratorBase.

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.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getDescription ()
 Returns the description string for this module.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 processContinue ()
 parseContinueParam ()
 getContinueStr ($lastPageID)
 getContinueRedirStr ($lastPageID, $lastRedirID)
 getExamples ()
 Returns usage examples for this module.

Private Member Functions

 prepareFirstQuery ($resultPageSet=null)
 prepareSecondQuery ($resultPageSet=null)
 run ($resultPageSet=null)
 extractRowInfo ($row)
 extractRedirRowInfo ($row)

Private Attributes

 $params
 $rootTitle
 $contRedirs
 $contLevel
 $contTitle
 $contID
 $redirID
 $redirect
 $bl_ns
 $bl_from
 $bl_table
 $bl_code
 $bl_title
 $bl_sort
 $bl_fields
 $hasNS
 $pageMap
 $resultArr
 $backlinksSettings


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


Constructor & Destructor Documentation

ApiQueryBacklinks::__construct ( query,
moduleName 
)

Definition at line 64 of file ApiQueryBacklinks.php.

References $code, and $prefix.


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

References run().

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

References run().

ApiQueryBacklinks::extractRedirRowInfo ( row  )  [private]

Definition at line 307 of file ApiQueryBacklinks.php.

References $ns, $row, ApiQueryBase::addTitleInfo(), and Title::makeTitle().

ApiQueryBacklinks::extractRowInfo ( row  )  [private]

Definition at line 293 of file ApiQueryBacklinks.php.

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

Referenced by run().

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

Reimplemented from ApiBase.

Definition at line 380 of file ApiQueryBacklinks.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.

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

Definition at line 376 of file ApiQueryBacklinks.php.

Referenced by run().

ApiQueryBacklinks::getContinueStr ( lastPageID  )  [protected]

Definition at line 370 of file ApiQueryBacklinks.php.

Referenced by run().

ApiQueryBacklinks::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 427 of file ApiQueryBacklinks.php.

References ApiBase::dieDebug().

ApiQueryBacklinks::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

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

Reimplemented from ApiBase.

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

ApiQueryBacklinks::parseContinueParam (  )  [protected]

Definition at line 341 of file ApiQueryBacklinks.php.

References Title::makeTitleSafe().

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

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

ApiQueryBacklinks::processContinue (  )  [protected]

Definition at line 320 of file ApiQueryBacklinks.php.

References $title, and Title::newFromText().

Referenced by run().

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


Member Data Documentation

ApiQueryBacklinks::$backlinksSettings [private]

Initial value:

 array (
                'backlinks' => array (
                        'code' => 'bl',
                        'prefix' => 'pl',
                        'linktbl' => 'pagelinks'
                ),
                'embeddedin' => array (
                        'code' => 'ei',
                        'prefix' => 'tl',
                        'linktbl' => 'templatelinks'
                ),
                'imageusage' => array (
                        'code' => 'iu',
                        'prefix' => 'il',
                        'linktbl' => 'imagelinks'
                )
        )

Definition at line 46 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_code [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_fields [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_from [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_ns [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_sort [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_table [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$bl_title [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$contID [private]

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$contLevel [private]

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$contRedirs [private]

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$contTitle [private]

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$hasNS [private]

Definition at line 42 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$pageMap [private]

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$params [private]

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$redirect [private]

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$redirID [private]

Definition at line 41 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$resultArr [private]

Definition at line 43 of file ApiQueryBacklinks.php.

ApiQueryBacklinks::$rootTitle [private]

Definition at line 41 of file ApiQueryBacklinks.php.


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

Generated on Sat Sep 5 02:08:31 2009 for MediaWiki by  doxygen 1.5.9