MediaWiki  REL1_24
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
ApiQueryRandom Class Reference
API

Query module to get list of random pages. More...

Inheritance diagram for ApiQueryRandom:
Inheritance graph
[legend]
Collaboration diagram for ApiQueryRandom:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct (ApiQuery $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.
 run ($resultPageSet=null)

Protected Member Functions

 prepareQuery ($randstr, $limit, $namespace, &$resultPageSet, $redirect)
 runQuery ($resultPageSet=null)

Private Member Functions

 extractRowInfo ($row)

Private Attributes

 $pageIDs

Detailed Description

Query module to get list of random pages.

Definition at line 33 of file ApiQueryRandom.php.

Constructor & Destructor Documentation

ApiQueryRandom::__construct ( ApiQuery $  query,
$  moduleName 
)

Definition at line 36 of file ApiQueryRandom.php.

Member Function Documentation

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 40 of file ApiQueryRandom.php.

References run().

ApiQueryRandom::executeGenerator ( $  resultPageSet)

Execute this module as a generator.

Parameters:
ApiPageSet$resultPageSetAll output should be appended to this object

Reimplemented from ApiQueryGeneratorBase.

Definition at line 44 of file ApiQueryRandom.php.

References run().

ApiQueryRandom::extractRowInfo ( $  row) [private]

Definition at line 138 of file ApiQueryRandom.php.

References $title, ApiQueryBase\addTitleInfo(), array(), 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.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns:
array|bool

Reimplemented from ApiBase.

Definition at line 151 of file ApiQueryRandom.php.

References array(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.

ApiQueryRandom::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:
array$params
Returns:
string

Reimplemented from ApiQueryBase.

Definition at line 147 of file ApiQueryRandom.php.

ApiQueryRandom::getDescription ( )

Returns the description string for this module.

Returns:
string|array

Reimplemented from ApiBase.

Definition at line 176 of file ApiQueryRandom.php.

References array().

ApiQueryRandom::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
bool|string|array

Reimplemented from ApiBase.

Definition at line 188 of file ApiQueryRandom.php.

ApiQueryRandom::getHelpUrls ( )
Returns:
bool|string|array Returns a false if the module has no help URL, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 192 of file ApiQueryRandom.php.

ApiQueryRandom::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:
array|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 168 of file ApiQueryRandom.php.

References array().

ApiQueryRandom::prepareQuery ( $  randstr,
$  limit,
$  namespace,
&$  resultPageSet,
$  redirect 
) [protected]
Parameters:
string$randstr
int$limit
int$namespace
ApiPageSet$resultPageSet
bool$redirect
Returns:
void

Definition at line 56 of file ApiQueryRandom.php.

References $limit, ApiQueryBase\addFields(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereRange(), array(), and ApiQueryBase\resetQueryParams().

Referenced by run().

ApiQueryRandom::run ( $  resultPageSet = null)
Parameters:
ApiPageSet$resultPageSet
Returns:
void

Definition at line 105 of file ApiQueryRandom.php.

References $count, $params, $result, array(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), prepareQuery(), runQuery(), and wfRandom().

Referenced by execute(), and executeGenerator().

ApiQueryRandom::runQuery ( $  resultPageSet = null) [protected]
Parameters:
ApiPageSet$resultPageSet
Returns:
int

Definition at line 74 of file ApiQueryRandom.php.

References $count, $res, array(), as, extractRowInfo(), ApiBase\getModuleName(), ApiBase\getResult(), and ApiQueryBase\select().

Referenced by run().

Member Data Documentation

ApiQueryRandom::$pageIDs [private]

Definition at line 34 of file ApiQueryRandom.php.

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