Inherits ApiQueryGeneratorBase.
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. | |
run ($resultPageSet=null) | |
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 | |
prepareQuery ($randstr, $limit, $namespace, &$resultPageSet, $redirect) | |
runQuery (&$resultPageSet) | |
getExamples () | |
Returns usage examples for this module. | |
Private Member Functions | |
extractRowInfo ($row) |
Definition at line 37 of file ApiQueryRandom.php.
ApiQueryRandom::__construct | ( | $ | query, | |
$ | moduleName | |||
) |
Definition at line 39 of file ApiQueryRandom.php.
ApiQueryRandom::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 43 of file ApiQueryRandom.php.
References run().
ApiQueryRandom::executeGenerator | ( | $ | resultPageSet | ) |
Execute this module as a generator.
$resultPageSet | ApiPageSet: All output should be appended to this object |
Reimplemented from ApiQueryGeneratorBase.
Definition at line 47 of file ApiQueryRandom.php.
References run().
ApiQueryRandom::extractRowInfo | ( | $ | row | ) | [private] |
Definition at line 116 of file ApiQueryRandom.php.
References $row, $title, ApiQueryBase::addTitleInfo(), and Title::makeTitle().
Referenced by runQuery().
ApiQueryRandom::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 124 of file ApiQueryRandom.php.
References ApiBase::PARAM_DFLT, ApiBase::PARAM_ISMULTI, ApiBase::PARAM_MAX, ApiBase::PARAM_MAX2, ApiBase::PARAM_MIN, and ApiBase::PARAM_TYPE.
ApiQueryRandom::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 149 of file ApiQueryRandom.php.
ApiQueryRandom::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 157 of file ApiQueryRandom.php.
ApiQueryRandom::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 141 of file ApiQueryRandom.php.
ApiQueryRandom::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 161 of file ApiQueryRandom.php.
ApiQueryRandom::prepareQuery | ( | $ | randstr, | |
$ | limit, | |||
$ | namespace, | |||
&$ | resultPageSet, | |||
$ | redirect | |||
) | [protected] |
Definition at line 51 of file ApiQueryRandom.php.
References ApiQueryBase::addFields(), ApiQueryBase::addOption(), ApiQueryBase::addTables(), ApiQueryBase::addWhereFld(), ApiQueryBase::addWhereRange(), and ApiQueryBase::resetQueryParams().
Referenced by run().
ApiQueryRandom::run | ( | $ | resultPageSet = null |
) |
Definition at line 94 of file ApiQueryRandom.php.
References $count, $result, ApiBase::extractRequestParams(), ApiBase::getModuleName(), ApiBase::getResult(), prepareQuery(), runQuery(), and wfRandom().
Referenced by execute(), and executeGenerator().
ApiQueryRandom::runQuery | ( | &$ | resultPageSet | ) | [protected] |
Definition at line 65 of file ApiQueryRandom.php.
References $count, $db, $res, $row, extractRowInfo(), ApiQueryBase::getDB(), ApiBase::getModuleName(), ApiBase::getResult(), and ApiQueryBase::select().
Referenced by run().