A query action to get image information from temporarily stashed files. 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. | |
| getDescription () | |
| Returns the description string for this module. | |
| getExamples () | |
| Returns usage examples for this module. | |
| getParamDescription () | |
| Return the API documentation for the parameters. | |
| getResultProperties () | |
| Returns possible properties in the result, grouped by the value of the prop parameter that shows them. | |
Private Attributes | |
| $propertyFilter | |
Detailed Description
A query action to get image information from temporarily stashed files.
Definition at line 28 of file ApiQueryStashImageInfo.php.
Constructor & Destructor Documentation
| ApiQueryStashImageInfo::__construct | ( | $ | query, |
| $ | moduleName | ||
| ) |
Definition at line 30 of file ApiQueryStashImageInfo.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 ApiQueryImageInfo.
Definition at line 34 of file ApiQueryStashImageInfo.php.
References $file, $params, $result, array(), as, ApiBase\dieUsage(), ApiBase\extractRequestParams(), ApiQueryImageInfo\getInfo(), ApiBase\getModuleName(), ApiBase\getModulePrefix(), ApiBase\getResult(), ApiQueryImageInfo\getScale(), ApiQueryImageInfo\mergeThumbParams(), and RepoGroup\singleton().
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 ApiQueryImageInfo.
Definition at line 78 of file ApiQueryStashImageInfo.php.
References array(), ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiQueryImageInfo.
Definition at line 130 of file ApiQueryStashImageInfo.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiQueryImageInfo.
Definition at line 134 of file ApiQueryStashImageInfo.php.
References array().
Return the API documentation for the parameters.
- Returns:
- Array parameter documentation.
Reimplemented from ApiQueryImageInfo.
Definition at line 113 of file ApiQueryStashImageInfo.php.
References array(), and ApiBase\getModulePrefix().
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 function directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.
- Returns:
- array|bool False on no properties
Reimplemented from ApiQueryImageInfo.
Definition at line 126 of file ApiQueryStashImageInfo.php.
References ApiQueryImageInfo\getResultPropertiesFiltered().
Member Data Documentation
ApiQueryStashImageInfo::$propertyFilter [private] |
array( 'user', 'userid', 'comment', 'parsedcomment', 'mediatype', 'archivename', )
Definition at line 73 of file ApiQueryStashImageInfo.php.
The documentation for this class was generated from the following file:
- includes/api/ApiQueryStashImageInfo.php
