API interface for setting the wl_notificationtimestamp field. More...

Inheritance diagram for ApiSetNotificationTimestamp:

Collaboration diagram for ApiSetNotificationTimestamp:

Public Member Functions
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getAllowedParams ($flags=0)
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
	getTokenSalt ()
	Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token You have also to override needsToken() Value is passed to User::getEditToken.
	isWriteMode ()
	Indicates whether this module requires write mode.
	mustBePosted ()
	Indicates whether this module must be called with a POST request.
	needsToken ()
	Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248.
Private Member Functions
	getPageSet ()
	Get a cached instance of an ApiPageSet object.
Private Attributes
	$mPageSet

Detailed Description

API interface for setting the wl_notificationtimestamp field.

Definition at line 32 of file ApiSetNotificationTimestamp.php.

Member Function Documentation

ApiSetNotificationTimestamp::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 36 of file ApiSetNotificationTimestamp.php.

References $lb, $params, $res, $result, $rev, $timestamp, $title, $user, array(), as, ApiBase\dieUsage(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), getPageSet(), ApiBase\getResult(), Revision\getTimestampFromId(), ContextSource\getUser(), ApiBase\requireMaxOneParameter(), wfGetDB(), and wfTimestamp().

ApiSetNotificationTimestamp::getAllowedParams ( $ flags = 0 )

Definition at line 194 of file ApiSetNotificationTimestamp.php.

References $flags, $result, array(), getPageSet(), and ApiBase\PARAM_TYPE.

ApiSetNotificationTimestamp::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 264 of file ApiSetNotificationTimestamp.php.

References array().

ApiSetNotificationTimestamp::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 289 of file ApiSetNotificationTimestamp.php.

References array().

ApiSetNotificationTimestamp::getHelpUrls ( )

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 297 of file ApiSetNotificationTimestamp.php.

ApiSetNotificationTimestamp::getPageSet ( ) [private]

Get a cached instance of an ApiPageSet object.

Returns:: ApiPageSet

Definition at line 171 of file ApiSetNotificationTimestamp.php.

Referenced by execute(), getAllowedParams(), getParamDescription(), and getPossibleErrors().

ApiSetNotificationTimestamp::getParamDescription ( )

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 217 of file ApiSetNotificationTimestamp.php.

References array(), and getPageSet().

ApiSetNotificationTimestamp::getPossibleErrors ( )

Returns a list of all possible errors returned by the module.

Don't call this function directly: use getFinalPossibleErrors() to allow hooks to modify parameters as needed.

Returns:: array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 272 of file ApiSetNotificationTimestamp.php.

References array(), getPageSet(), ApiBase\getRequireMaxOneParameterErrorMessages(), and ApiBase\getRequireOnlyOneParameterErrorMessages().

ApiSetNotificationTimestamp::getResultProperties ( )

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 ApiBase.

Definition at line 227 of file ApiSetNotificationTimestamp.php.

References array(), ApiBase\PROP_LIST, ApiBase\PROP_NULLABLE, ApiBase\PROP_ROOT, and ApiBase\PROP_TYPE.

ApiSetNotificationTimestamp::getTokenSalt ( )

Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token You have also to override needsToken() Value is passed to User::getEditToken.