Inherits ApiQueryGeneratorBase.
Public Member Functions | |
__construct ($query, $moduleName) | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getCacheMode ($params) | |
Get the cache mode for the data generated by this module. | |
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. | |
getPossibleErrors () | |
Returns a list of all possible errors returned by the 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 |
Definition at line 39 of file ApiQueryBacklinks.php.
ApiQueryBacklinks::__construct | ( | $ | query, | |
$ | moduleName | |||
) |
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.
$resultPageSet | ApiPageSet: All output should be appended to this object |
Reimplemented from ApiQueryGeneratorBase.
Definition at line 99 of file ApiQueryBacklinks.php.
References run().
ApiQueryBacklinks::extractRedirRowInfo | ( | $ | row | ) | [private] |
Definition at line 324 of file ApiQueryBacklinks.php.
References ApiQueryBase::addTitleInfo(), ApiBase::getResult(), and Title::makeTitle().
Referenced by run().
ApiQueryBacklinks::extractRowInfo | ( | $ | row | ) | [private] |
Definition at line 310 of file ApiQueryBacklinks.php.
References $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.
Reimplemented from ApiBase.
Definition at line 400 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, and ApiBase::PARAM_TYPE.
ApiQueryBacklinks::getCacheMode | ( | $ | params | ) |
Get the cache mode for the data generated by this module.
Override this in the module subclass.
Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.
Reimplemented from ApiQueryBase.
Definition at line 95 of file ApiQueryBacklinks.php.
ApiQueryBacklinks::getContinueRedirStr | ( | $ | lastPageID, | |
$ | lastRedirID | |||
) | [protected] |
Definition at line 396 of file ApiQueryBacklinks.php.
References getContinueStr().
Referenced by run().
ApiQueryBacklinks::getContinueStr | ( | $ | lastPageID | ) | [protected] |
Definition at line 390 of file ApiQueryBacklinks.php.
Referenced by getContinueRedirStr(), and run().
ApiQueryBacklinks::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 448 of file ApiQueryBacklinks.php.
References ApiBase::dieDebug(), and ApiBase::getModuleName().
ApiQueryBacklinks::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 470 of file ApiQueryBacklinks.php.
References ApiBase::getModuleName().
ApiQueryBacklinks::getParamDescription | ( | ) |
Returns an array of parameter descriptions.
Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 430 of file ApiQueryBacklinks.php.
References ApiBase::getModuleName().
ApiQueryBacklinks::getPossibleErrors | ( | ) |
Returns a list of all possible errors returned by the module.
Reimplemented from ApiQueryBase.
Definition at line 461 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
Reimplemented from ApiBase.
Definition at line 489 of file ApiQueryBacklinks.php.
ApiQueryBacklinks::parseContinueParam | ( | ) | [protected] |
Definition at line 358 of file ApiQueryBacklinks.php.
References $contID, $redirID, ApiBase::dieUsage(), and Title::makeTitleSafe().
Referenced by processContinue().
ApiQueryBacklinks::prepareFirstQuery | ( | $ | resultPageSet = null |
) | [private] |
Definition at line 103 of file ApiQueryBacklinks.php.
References ApiQueryBase::addFields(), ApiQueryBase::addOption(), ApiQueryBase::addTables(), ApiQueryBase::addWhere(), ApiQueryBase::addWhereFld(), and ApiQueryBase::getDB().
Referenced by run().
ApiQueryBacklinks::prepareSecondQuery | ( | $ | resultPageSet = null |
) | [private] |
Definition at line 138 of file ApiQueryBacklinks.php.
References $t, $title, ApiQueryBase::addFields(), ApiQueryBase::addOption(), ApiQueryBase::addTables(), ApiQueryBase::addWhere(), ApiQueryBase::addWhereFld(), and ApiQueryBase::getDB().
Referenced by run().
ApiQueryBacklinks::processContinue | ( | ) | [protected] |
Definition at line 337 of file ApiQueryBacklinks.php.
References $title, ApiBase::dieUsage(), ApiBase::dieUsageMsg(), Title::newFromText(), and parseContinueParam().
Referenced by run().
ApiQueryBacklinks::run | ( | $ | resultPageSet = null |
) | [private] |
Definition at line 193 of file ApiQueryBacklinks.php.
References $res, extractRedirRowInfo(), ApiBase::extractRequestParams(), extractRowInfo(), getContinueRedirStr(), getContinueStr(), ApiQueryBase::getDB(), 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().
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] |
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] |
ApiQueryBacklinks::$resultArr [private] |
Definition at line 43 of file ApiQueryBacklinks.php.
ApiQueryBacklinks::$rootTitle [private] |
Definition at line 41 of file ApiQueryBacklinks.php.