Query module to enumerate change tags. More...
Public Member Functions | |
| __construct ($query, $moduleName) | |
| execute () | |
| Evaluates the parameters, performs the requested query, and sets up the result. | |
| 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. | |
| getParamDescription () | |
| Returns an array of parameter descriptions. | |
| getResultProperties () | |
| Returns possible properties in the result, grouped by the value of the prop parameter that shows them. | |
| getVersion () | |
| Returns a string that identifies the version of the extending class. | |
Public Attributes | |
| $fld_description = false | |
| $fld_hitcount = false | |
Private Member Functions | |
| doTag ($tagName, $hitcount) | |
Private Attributes | |
| $fld_displayname = false | |
| $limit | |
| ApiResult | $result |
Detailed Description
Query module to enumerate change tags.
Definition at line 32 of file ApiQueryTags.php.
Constructor & Destructor Documentation
| ApiQueryTags::__construct | ( | $ | query, |
| $ | moduleName | ||
| ) |
Definition at line 42 of file ApiQueryTags.php.
References $query.
Member Function Documentation
| ApiQueryTags::doTag | ( | $ | tagName, |
| $ | hitcount | ||
| ) | [private] |
Definition at line 89 of file ApiQueryTags.php.
References $count, array(), ApiBase\getModuleName(), ApiQueryBase\setContinueEnumParameter(), ChangeTags\tagDescription(), and wfMessage().
Referenced by 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 46 of file ApiQueryTags.php.
References $ok, $params, $res, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addWhereRange(), array(), as, doTag(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ChangeTags\listDefinedTags(), and ApiQueryBase\select().
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|bool
Reimplemented from ApiBase.
Definition at line 133 of file ApiQueryTags.php.
References array(), 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.
| ApiQueryTags::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 129 of file ApiQueryTags.php.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 188 of file ApiQueryTags.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 192 of file ApiQueryTags.php.
References array().
Returns an array of parameter descriptions.
Don't call this functon 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 157 of file ApiQueryTags.php.
References array().
Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.
Don't call this functon directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.
- Returns:
- array|bool False on no properties
Reimplemented from ApiBase.
Definition at line 171 of file ApiQueryTags.php.
References array().
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 198 of file ApiQueryTags.php.
Member Data Documentation
| ApiQueryTags::$fld_description = false |
Definition at line 39 of file ApiQueryTags.php.
ApiQueryTags::$fld_displayname = false [private] |
Definition at line 39 of file ApiQueryTags.php.
| ApiQueryTags::$fld_hitcount = false |
Definition at line 40 of file ApiQueryTags.php.
ApiQueryTags::$limit [private] |
Definition at line 38 of file ApiQueryTags.php.
ApiResult ApiQueryTags::$result [private] |
Definition at line 36 of file ApiQueryTags.php.
The documentation for this class was generated from the following file:
- includes/api/ApiQueryTags.php
