A query module to enumerate categories the set of pages belong to. More...
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. | |
| 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. | |
Private Member Functions | |
| run ($resultPageSet=null) | |
Detailed Description
A query module to enumerate categories the set of pages belong to.
Definition at line 32 of file ApiQueryCategories.php.
Constructor & Destructor Documentation
| ApiQueryCategories::__construct | ( | $ | query, |
| $ | moduleName | ||
| ) |
Definition at line 34 of file ApiQueryCategories.php.
Member Function Documentation
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 38 of file ApiQueryCategories.php.
References run().
| ApiQueryCategories::executeGenerator | ( | $ | resultPageSet | ) |
Execute this module as a generator.
- Parameters:
-
$resultPageSet ApiPageSet: All output should be appended to this object
Reimplemented from ApiQueryGeneratorBase.
Definition at line 46 of file ApiQueryCategories.php.
References run().
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 188 of file ApiQueryCategories.php.
References 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.
| ApiQueryCategories::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 42 of file ApiQueryCategories.php.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 242 of file ApiQueryCategories.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- false|string|array
Reimplemented from ApiBase.
Definition at line 252 of file ApiQueryCategories.php.
- 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 259 of file ApiQueryCategories.php.
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 226 of file ApiQueryCategories.php.
- Returns:
- array
Reimplemented from ApiQueryBase.
Definition at line 246 of file ApiQueryCategories.php.
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 263 of file ApiQueryCategories.php.
| ApiQueryCategories::run | ( | $ | resultPageSet = null | ) | [private] |
- Parameters:
-
$resultPageSet ApiPageSet
- Returns:
Definition at line 54 of file ApiQueryCategories.php.
References $count, $dir, $res, $title, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addJoinConds(), ApiQueryBase\addOption(), ApiQueryBase\addPageSubItem(), ApiQueryBase\addTables(), ApiQueryBase\addTitleInfo(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiQueryBase\getDB(), ApiQueryBase\getPageSet(), Title\makeTitle(), Title\newFromText(), ApiQueryBase\select(), ApiQueryBase\setContinueEnumParameter(), ApiBase\setWarning(), ApiQueryBase\titleToKey(), and wfTimestamp().
Referenced by execute(), and executeGenerator().
The documentation for this class was generated from the following file:
- includes/api/ApiQueryCategories.php
