A query module to show basic page information. 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. | |
Private Member Functions | |
| addPageProps ($result, $page, $props) | |
| Add page properties to an ApiResult, adding a continue parameter if it doesn't fit. | |
Private Attributes | |
| $params | |
Detailed Description
A query module to show basic page information.
Definition at line 32 of file ApiQueryPageProps.php.
Constructor & Destructor Documentation
| ApiQueryPageProps::__construct | ( | $ | query, |
| $ | moduleName | ||
| ) |
Definition at line 36 of file ApiQueryPageProps.php.
References $query.
Member Function Documentation
| ApiQueryPageProps::addPageProps | ( | $ | result, |
| $ | page, | ||
| $ | props | ||
| ) | [private] |
Add page properties to an ApiResult, adding a continue parameter if it doesn't fit.
- Parameters:
-
$result ApiResult $page int $props array
- Returns:
- bool True if it fits in the result
Definition at line 112 of file ApiQueryPageProps.php.
References $result, array(), and ApiQueryBase\setContinueEnumParameter().
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 40 of file ApiQueryPageProps.php.
References $res, $result, ApiQueryBase\addFields(), ApiQueryBase\addOption(), addPageProps(), ApiQueryBase\addTables(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), array(), as, ApiBase\extractRequestParams(), ApiQueryBase\getPageSet(), ApiBase\getResult(), of, page, params, 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.
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 125 of file ApiQueryPageProps.php.
References array(), and ApiBase\PARAM_ISMULTI.
| ApiQueryPageProps::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 121 of file ApiQueryPageProps.php.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 141 of file ApiQueryPageProps.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 145 of file ApiQueryPageProps.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 151 of file ApiQueryPageProps.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 134 of file ApiQueryPageProps.php.
References array().
Member Data Documentation
ApiQueryPageProps::$params [private] |
Definition at line 34 of file ApiQueryPageProps.php.
The documentation for this class was generated from the following file:
- includes/api/ApiQueryPageProps.php
