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. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Protected Member Functions | |
getExamples () | |
Returns usage examples for this module. | |
Private Member Functions | |
run ($resultPageSet=null) |
Definition at line 36 of file ApiQueryAllpages.php.
ApiQueryAllpages::__construct | ( | $ | query, | |
$ | moduleName | |||
) |
Definition at line 38 of file ApiQueryAllpages.php.
ApiQueryAllpages::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 42 of file ApiQueryAllpages.php.
References run().
ApiQueryAllpages::executeGenerator | ( | $ | resultPageSet | ) |
Execute this module as a generator.
$resultPageSet | ApiPageSet: All output should be appended to this object |
Reimplemented from ApiQueryGeneratorBase.
Definition at line 50 of file ApiQueryAllpages.php.
References ApiBase::dieUsage(), and run().
ApiQueryAllpages::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 175 of file ApiQueryAllpages.php.
References $wgRestrictionLevels, $wgRestrictionTypes, 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.
ApiQueryAllpages::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 46 of file ApiQueryAllpages.php.
ApiQueryAllpages::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 257 of file ApiQueryAllpages.php.
ApiQueryAllpages::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 261 of file ApiQueryAllpages.php.
ApiQueryAllpages::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 240 of file ApiQueryAllpages.php.
ApiQueryAllpages::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 274 of file ApiQueryAllpages.php.
ApiQueryAllpages::run | ( | $ | resultPageSet = null |
) | [private] |
Definition at line 57 of file ApiQueryAllpages.php.
References $count, $db, $res, $result, $row, $title, ApiQueryBase::addFields(), ApiQueryBase::addJoinConds(), ApiQueryBase::addOption(), ApiQueryBase::addTables(), ApiQueryBase::addWhere(), ApiQueryBase::addWhereFld(), ApiQueryBase::addWhereIf(), ApiQueryBase::addWhereRange(), ApiBase::dieUsage(), ApiBase::extractRequestParams(), ApiQueryBase::getDB(), ApiBase::getModuleName(), ApiBase::getResult(), ApiQueryBase::keyToTitle(), Title::makeTitle(), ApiQueryBase::select(), ApiQueryBase::setContinueEnumParameter(), and ApiQueryBase::titlePartToKey().
Referenced by execute(), and executeGenerator().