MediaWiki  REL1_24
Public Member Functions | Private Member Functions | Private Attributes
ApiWatch Class Reference
API

API module to allow users to watch a page. More...

Inheritance diagram for ApiWatch:
Inheritance graph
[legend]
Collaboration diagram for ApiWatch:
Collaboration graph
[legend]

List of all members.

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.
 isWriteMode ()
 Indicates whether this module requires write mode.
 mustBePosted ()
 Indicates whether this module must be called with a POST request.
 needsToken ()
 Returns the token type this module requires in order to execute.

Private Member Functions

 getPageSet ()
 Get a cached instance of an ApiPageSet object.
 watchTitle (Title $title, User $user, array $params, $compatibilityMode=false)

Private Attributes

 $mPageSet = null

Detailed Description

API module to allow users to watch a page.

Definition at line 32 of file ApiWatch.php.

Member Function Documentation

ApiWatch::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 35 of file ApiWatch.php.

References $params, $res, $title, $user, array(), as, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getModulePrefix(), getPageSet(), ApiBase\getResult(), ContextSource\getUser(), ApiBase\logFeatureUsage(), Title\newFromText(), and watchTitle().

ApiWatch::getAllowedParams ( $  flags = 0)

Definition at line 172 of file ApiWatch.php.

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

ApiWatch::getDescription ( )

Returns the description string for this module.

Returns:
string|array

Reimplemented from ApiBase.

Definition at line 200 of file ApiWatch.php.

ApiWatch::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
bool|string|array

Reimplemented from ApiBase.

Definition at line 204 of file ApiWatch.php.

References array().

ApiWatch::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 211 of file ApiWatch.php.

ApiWatch::getPageSet ( ) [private]

Get a cached instance of an ApiPageSet object.

Returns:
ApiPageSet

Definition at line 152 of file ApiWatch.php.

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

ApiWatch::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 189 of file ApiWatch.php.

References array(), and getPageSet().

ApiWatch::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 164 of file ApiWatch.php.

ApiWatch::mustBePosted ( )

Indicates whether this module must be called with a POST request.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 160 of file ApiWatch.php.

ApiWatch::needsToken ( )

Returns the token type this module requires in order to execute.

Modules are strongly encouraged to use the core 'csrf' type unless they have specialized security needs. If the token type is not one of the core types, you must use the ApiQueryTokensRegisterTypes hook to register it.

Returning a non-falsey value here will cause self::getFinalParams() to return a required string 'token' parameter and self::getFinalParamDescription() to ensure there is standardized documentation for it. Also, self::mustBePosted() must return true when tokens are used.

In previous versions of MediaWiki, true was a valid return value. Returning true will generate errors indicating that the API module needs updating.

Returns:
string|false

Reimplemented from ApiBase.

Definition at line 168 of file ApiWatch.php.

ApiWatch::watchTitle ( Title $  title,
User $  user,
array $  params,
$  compatibilityMode = false 
) [private]

Definition at line 98 of file ApiWatch.php.

References $res, array(), ApiBase\dieStatus(), WatchAction\doUnwatch(), WatchAction\doWatch(), Language\factory(), ContextSource\getContext(), ApiBase\getErrorFromStatus(), Title\getPrefixedText(), Title\isWatchable(), ContextSource\msg(), and title.

Referenced by execute().

Member Data Documentation

ApiWatch::$mPageSet = null [private]

Definition at line 33 of file ApiWatch.php.

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