A query module to list used page props. 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. | |
| getHelpUrls () | |
| getParamDescription () | |
| Returns an array of parameter descriptions. | |
Detailed Description
A query module to list used page props.
- Since:
- 1.21
Definition at line 33 of file ApiQueryPagePropNames.php.
Constructor & Destructor Documentation
| ApiQueryPagePropNames::__construct | ( | $ | query, |
| $ | moduleName | ||
| ) |
Definition at line 35 of file ApiQueryPagePropNames.php.
References $query.
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 43 of file ApiQueryPagePropNames.php.
References $count, $limit, $params, $result, ApiQueryBase\addFields(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addWhereRange(), array(), as, ApiBase\dieContinueUsageIf(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ApiQueryBase\select(), and ApiQueryBase\setContinueEnumParameter().
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 83 of file ApiQueryPagePropNames.php.
References array(), ApiBase\LIMIT_BIG1, ApiBase\LIMIT_BIG2, ApiBase\PARAM_DFLT, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.
| ApiQueryPagePropNames::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 39 of file ApiQueryPagePropNames.php.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 103 of file ApiQueryPagePropNames.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 107 of file ApiQueryPagePropNames.php.
References array().
- 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 113 of file ApiQueryPagePropNames.php.
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 96 of file ApiQueryPagePropNames.php.
References array().
The documentation for this class was generated from the following file:
- includes/api/ApiQueryPagePropNames.php
