MediaWiki  REL1_19
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
ApiQueryAllimages Class Reference
API

Query module to enumerate all available pages. More...

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

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)
 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.
 getPossibleErrors ()
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 getDB ()
 Override parent method to make sure to make sure the repo's DB is used which may not necesarilly be the same as the local DB.

Protected Attributes

 $mRepo

Private Member Functions

 run ($resultPageSet=null)

Private Attributes

 $propertyFilter = array( 'archivename' )

Detailed Description

Query module to enumerate all available pages.

Definition at line 34 of file ApiQueryAllimages.php.

Constructor & Destructor Documentation

ApiQueryAllimages::__construct ( $  query,
$  moduleName 
)

Definition at line 38 of file ApiQueryAllimages.php.

References RepoGroup\singleton().

Here is the call graph for this function:

Member Function Documentation

ApiQueryAllimages::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 54 of file ApiQueryAllimages.php.

References run().

Here is the call graph for this function:

ApiQueryAllimages::executeGenerator ( $  resultPageSet)
Parameters:
$resultPageSetApiPageSet
Returns:
void

Reimplemented from ApiQueryGeneratorBase.

Definition at line 66 of file ApiQueryAllimages.php.

References ApiBase\dieUsage(), and run().

Here is the call graph for this function:

ApiQueryAllimages::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 or false

Reimplemented from ApiBase.

Definition at line 179 of file ApiQueryAllimages.php.

References ApiQueryImageInfo\getPropertyNames(), 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.

Here is the call graph for this function:

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

Reimplemented from ApiQueryBase.

Definition at line 58 of file ApiQueryAllimages.php.

ApiQueryAllimages::getDB ( ) [protected]

Override parent method to make sure to make sure the repo's DB is used which may not necesarilly be the same as the local DB.

TODO: allow querying non-local repos.

Returns:
DatabaseBase

Reimplemented from ApiQueryBase.

Definition at line 50 of file ApiQueryAllimages.php.

Referenced by run().

Here is the caller graph for this function:

ApiQueryAllimages::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 233 of file ApiQueryAllimages.php.

ApiQueryAllimages::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
false|string|array

Reimplemented from ApiBase.

Definition at line 247 of file ApiQueryAllimages.php.

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

Reimplemented from ApiBase.

Definition at line 260 of file ApiQueryAllimages.php.

ApiQueryAllimages::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 or false

Reimplemented from ApiBase.

Definition at line 215 of file ApiQueryAllimages.php.

References ApiQueryImageInfo\getPropertyDescriptions().

Here is the call graph for this function:

ApiQueryAllimages::getPossibleErrors ( )
Returns:
array

Reimplemented from ApiQueryBase.

Definition at line 237 of file ApiQueryAllimages.php.

ApiQueryAllimages::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 264 of file ApiQueryAllimages.php.

ApiQueryAllimages::run ( $  resultPageSet = null) [private]
Parameters:
$resultPageSetApiPageSet
Returns:
void

Definition at line 78 of file ApiQueryAllimages.php.

References $count, $dir, $file, $limit, $res, $result, $wgMiserMode, ApiQueryBase\addFields(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTitleInfo(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereRange(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), getDB(), ApiQueryImageInfo\getInfo(), ApiBase\getModuleName(), ApiBase\getResult(), ApiQueryBase\keyToTitle(), Title\makeTitle(), ApiQueryBase\select(), LocalFile\selectFields(), ApiQueryBase\setContinueEnumParameter(), File\splitMime(), ApiQueryBase\titlePartToKey(), ApiQueryBase\validateSha1Base36Hash(), ApiQueryBase\validateSha1Hash(), and wfBaseConvert().

Referenced by execute(), and executeGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ApiQueryAllimages::$mRepo [protected]

Definition at line 36 of file ApiQueryAllimages.php.

ApiQueryAllimages::$propertyFilter = array( 'archivename' ) [private]

Definition at line 231 of file ApiQueryAllimages.php.

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