ApiQueryContributions Class Reference
[API]

This query action adds a list of a specified user's contributions to the output. More...

Inherits ApiQueryBase.

List of all members.

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.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getDescription ()
 Returns the description string for this module.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 getExamples ()
 Returns usage examples for this module.

Private Member Functions

 prepareUsername ($user)
 Validate the 'user' parameter and set the value to compare against `revision`.
 prepareQuery ()
 Prepares the query and returns the limit of rows requested.
 extractRowInfo ($row)
 Extract fields from the database row and append them to a result array.
 continueStr ($row)

Private Attributes

 $params
 $username
 $fld_ids = false
 $fld_title = false
 $fld_timestamp = false
 $fld_comment = false
 $fld_flags = false
 $fld_patrolled = false


Detailed Description

This query action adds a list of a specified user's contributions to the output.

Definition at line 36 of file ApiQueryUserContributions.php.


Constructor & Destructor Documentation

ApiQueryContributions::__construct ( query,
moduleName 
)

Definition at line 38 of file ApiQueryUserContributions.php.


Member Function Documentation

ApiQueryContributions::continueStr ( row  )  [private]

Definition at line 284 of file ApiQueryUserContributions.php.

References $row, and wfTimestamp().

Referenced by execute().

ApiQueryContributions::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 47 of file ApiQueryUserContributions.php.

References $count, $db, $res, $row, $u, continueStr(), ApiBase::extractRequestParams(), extractRowInfo(), ApiQueryBase::getDB(), 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.

Definition at line 248 of file ApiQueryUserContributions.php.

References $row, ApiQueryBase::addTitleInfo(), Title::makeTitle(), and wfTimestamp().

Referenced by execute().

ApiQueryContributions::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.

Returns:
array

Reimplemented from ApiBase.

Definition at line 290 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::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 361 of file ApiQueryUserContributions.php.

ApiQueryContributions::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 365 of file ApiQueryUserContributions.php.

ApiQueryContributions::getParamDescription (  ) 

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:
array

Reimplemented from ApiBase.

Definition at line 345 of file ApiQueryUserContributions.php.

ApiQueryContributions::getVersion (  ) 

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 372 of file ApiQueryUserContributions.php.

ApiQueryContributions::prepareQuery (  )  [private]

ApiQueryContributions::prepareUsername ( user  )  [private]

Validate the 'user' parameter and set the value to compare against `revision`.

`rev_user_text`

Definition at line 122 of file ApiQueryUserContributions.php.

References $name, $user, ApiBase::dieUsage(), User::getCanonicalName(), and User::isIP().

Referenced by execute().


Member Data Documentation

ApiQueryContributions::$fld_comment = false [private]

Definition at line 44 of file ApiQueryUserContributions.php.

ApiQueryContributions::$fld_flags = false [private]

Definition at line 44 of file ApiQueryUserContributions.php.

ApiQueryContributions::$fld_ids = false [private]

Definition at line 43 of file ApiQueryUserContributions.php.

ApiQueryContributions::$fld_patrolled = false [private]

Definition at line 45 of file ApiQueryUserContributions.php.

ApiQueryContributions::$fld_timestamp = false [private]

Definition at line 43 of file ApiQueryUserContributions.php.

ApiQueryContributions::$fld_title = false [private]

Definition at line 43 of file ApiQueryUserContributions.php.

ApiQueryContributions::$params [private]

Definition at line 42 of file ApiQueryUserContributions.php.

ApiQueryContributions::$username [private]

Definition at line 42 of file ApiQueryUserContributions.php.


The documentation for this class was generated from the following file:

Generated on Sat Sep 5 02:08:32 2009 for MediaWiki by  doxygen 1.5.9