MediaWiki
REL1_19
|
This query action adds a list of a specified user's contributions to the output. 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. | |
getPossibleErrors () | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Public Attributes | |
$fld_comment = false | |
$fld_flags = false | |
$fld_parsedcomment = false | |
$fld_patrolled = false | |
$fld_size = false | |
$fld_tags = false | |
$fld_timestamp = false | |
$fld_title = false | |
$multiUserMode | |
$prefixMode | |
$usernames | |
$userprefix | |
Private Member Functions | |
continueStr ($row) | |
extractRowInfo ($row) | |
Extract fields from the database row and append them to a result array. | |
prepareQuery () | |
Prepares the query and returns the limit of rows requested. | |
prepareUsername ($user) | |
Validate the 'user' parameter and set the value to compare against `revision`. | |
Private Attributes | |
$fld_ids = false | |
$params |
This query action adds a list of a specified user's contributions to the output.
Definition at line 32 of file ApiQueryUserContributions.php.
ApiQueryContributions::__construct | ( | $ | query, |
$ | moduleName | ||
) |
Definition at line 34 of file ApiQueryUserContributions.php.
ApiQueryContributions::continueStr | ( | $ | row | ) | [private] |
Definition at line 348 of file ApiQueryUserContributions.php.
References wfTimestamp().
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 43 of file ApiQueryUserContributions.php.
References $count, $limit, $res, continueStr(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), extractRowInfo(), ApiBase\getModuleName(), ApiBase\getResult(), prepareQuery(), prepareUsername(), ApiQueryBase\select(), ApiQueryBase\selectNamedDB(), ApiQueryBase\setContinueEnumParameter(), and wfTimestamp().
ApiQueryContributions::extractRowInfo | ( | $ | row | ) | [private] |
Extract fields from the database row and append them to a result array.
$row |
Definition at line 277 of file ApiQueryUserContributions.php.
References $title, ApiQueryBase\addTitleInfo(), Revision\DELETED_COMMENT, Revision\DELETED_USER, Linker\formatComment(), ApiBase\getResult(), Title\makeTitle(), and wfTimestamp().
Referenced by execute().
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.
Reimplemented from ApiBase.
Definition at line 359 of file ApiQueryUserContributions.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.
ApiQueryContributions::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.
$params |
Reimplemented from ApiQueryBase.
Definition at line 353 of file ApiQueryUserContributions.php.
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 450 of file ApiQueryUserContributions.php.
Returns usage examples for this module.
Return false if no examples are available.
Reimplemented from ApiBase.
Definition at line 463 of file ApiQueryUserContributions.php.
Reimplemented from ApiBase.
Definition at line 470 of file ApiQueryUserContributions.php.
Returns an array of parameter descriptions.
Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 419 of file ApiQueryUserContributions.php.
References $wgRCMaxAge, ApiQueryBase\getDirectionDescription(), and ApiBase\getModulePrefix().
Reimplemented from ApiQueryBase.
Definition at line 454 of file ApiQueryUserContributions.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
Reimplemented from ApiBase.
Definition at line 474 of file ApiQueryUserContributions.php.
ApiQueryContributions::prepareQuery | ( | ) | [private] |
Prepares the query and returns the limit of rows requested.
Definition at line 140 of file ApiQueryUserContributions.php.
References ApiQueryBase\$tables, $user, $wgOldChangeTagsIndex, ApiQueryBase\addFields(), ApiQueryBase\addFieldsIf(), ApiQueryBase\addJoinConds(), ApiQueryBase\addOption(), ApiQueryBase\addTables(), ApiQueryBase\addTimestampWhereRange(), ApiQueryBase\addWhere(), ApiQueryBase\addWhereFld(), ApiQueryBase\addWhereIf(), ApiQueryBase\addWhereRange(), Revision\DELETED_USER, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiQueryBase\getDB(), ContextSource\getUser(), and wfTimestamp().
Referenced by execute().
ApiQueryContributions::prepareUsername | ( | $ | user | ) | [private] |
Validate the 'user' parameter and set the value to compare against `revision`.
`rev_user_text`
$user | string |
Definition at line 122 of file ApiQueryUserContributions.php.
References $user, ApiBase\dieUsage(), User\getCanonicalName(), and User\isIP().
Referenced by execute().
ApiQueryContributions::$fld_comment = false |
Definition at line 40 of file ApiQueryUserContributions.php.
ApiQueryContributions::$fld_flags = false |
Definition at line 40 of file ApiQueryUserContributions.php.
ApiQueryContributions::$fld_ids = false [private] |
Definition at line 39 of file ApiQueryUserContributions.php.
ApiQueryContributions::$fld_parsedcomment = false |
Definition at line 40 of file ApiQueryUserContributions.php.
ApiQueryContributions::$fld_patrolled = false |
Definition at line 41 of file ApiQueryUserContributions.php.
ApiQueryContributions::$fld_size = false |
Definition at line 41 of file ApiQueryUserContributions.php.
ApiQueryContributions::$fld_tags = false |
Definition at line 41 of file ApiQueryUserContributions.php.
ApiQueryContributions::$fld_timestamp = false |
Definition at line 39 of file ApiQueryUserContributions.php.
ApiQueryContributions::$fld_title = false |
Definition at line 39 of file ApiQueryUserContributions.php.
ApiQueryContributions::$multiUserMode |
Definition at line 38 of file ApiQueryUserContributions.php.
ApiQueryContributions::$params [private] |
Definition at line 38 of file ApiQueryUserContributions.php.
ApiQueryContributions::$prefixMode |
Definition at line 38 of file ApiQueryUserContributions.php.
ApiQueryContributions::$usernames |
Definition at line 38 of file ApiQueryUserContributions.php.
ApiQueryContributions::$userprefix |
Definition at line 38 of file ApiQueryUserContributions.php.