Query module to enumerate all deleted 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 () | |
| Returns an array of parameter descriptions. | |
| getPossibleErrors () | |
| getVersion () | |
| Returns a string that identifies the version of the extending class. | |
Detailed Description
Query module to enumerate all deleted files.
Definition at line 34 of file ApiQueryFilearchive.php.
Constructor & Destructor Documentation
| ApiQueryFilearchive::__construct | ( | $ | query, |
| $ | moduleName | ||
| ) |
Definition at line 36 of file ApiQueryFilearchive.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 40 of file ApiQueryFilearchive.php.
References $count, $dir, $file, $limit, $res, $result, $title, $user, $wgMiserMode, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTitleInfo(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereRange(), File\DELETED_COMMENT, File\DELETED_FILE, File\DELETED_RESTRICTED, File\DELETED_USER, ApiBase\dieUsage(), ApiBase\extractRequestParams(), Linker\formatComment(), ApiQueryBase\getDB(), LocalRepo\getHashFromKey(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), ApiQueryBase\keyToTitle(), Title\makeTitle(), ArchivedFile\newFromRow(), ApiQueryImageInfo\processMetaData(), ApiQueryBase\select(), ApiQueryBase\setContinueEnumParameter(), ApiQueryBase\titlePartToKey(), ApiQueryBase\validateSha1Base36Hash(), ApiQueryBase\validateSha1Hash(), wfBaseConvert(), and wfTimestamp().
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 205 of file ApiQueryFilearchive.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.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 270 of file ApiQueryFilearchive.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- false|string|array
Reimplemented from ApiBase.
Definition at line 283 of file ApiQueryFilearchive.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 245 of file ApiQueryFilearchive.php.
- Returns:
- array
Reimplemented from ApiQueryBase.
Definition at line 274 of file ApiQueryFilearchive.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 292 of file ApiQueryFilearchive.php.
The documentation for this class was generated from the following file:
- includes/api/ApiQueryFilearchive.php
