API module to allow users to watch a page. More...
Inherits MediaWiki\Api\ApiBase.
Public Member Functions | |
| __construct (ApiMain $mainModule, string $moduleName, WatchlistManager $watchlistManager, TitleFormatter $titleFormatter) | |
| execute () | |
| Evaluates the parameters, performs the requested query, and sets up the result. | |
| getAllowedParams ( $flags=0) | |
| getHelpUrls () | |
| Return links to more detailed help pages about the module. | |
| isWriteMode () | |
| Indicates whether this module requires write access to the wiki. | |
| mustBePosted () | |
| Indicates whether this module must be called with a POST request. | |
| needsToken () | |
| Returns the token type this module requires in order to execute. | |
 Public Member Functions inherited from MediaWiki\Api\ApiBase | |
| __construct (ApiMain $mainModule, string $moduleName, string $modulePrefix='') | |
| getModuleManager () | |
| Get the module manager, or null if this module has no submodules. | |
| getCustomPrinter () | |
| If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. | |
| shouldCheckMaxlag () | |
| Indicates if this module needs maxlag to be checked. | |
| isReadMode () | |
| Indicates whether this module requires read rights. | |
| isDeprecated () | |
| Indicates whether this module is deprecated. | |
| isInternal () | |
| Indicates whether this module is considered to be "internal". | |
| getConditionalRequestData ( $condition) | |
| Returns data for HTTP conditional request mechanisms. | |
| getModuleName () | |
| Get the name of the module being executed by this instance. | |
| getModulePrefix () | |
| Get parameter prefix (usually two letters or an empty string). | |
| getMain () | |
| Get the main module. | |
| isMain () | |
| Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. | |
| getParent () | |
| Get the parent of this module. | |
| lacksSameOriginSecurity () | |
| Returns true if the current request breaks the same-origin policy. | |
| getModulePath () | |
| Get the path to this module. | |
| getModuleFromPath ( $path) | |
| Get a module from its module path. | |
| getResult () | |
| Get the result object. | |
| getErrorFormatter () | |
| getContinuationManager () | |
| setContinuationManager (?ApiContinuationManager $manager=null) | |
| dynamicParameterDocumentation () | |
| Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). | |
| encodeParamName ( $paramName) | |
| This method mangles parameter name based on the prefix supplied to the constructor. | |
| extractRequestParams ( $options=[]) | |
| Using getAllowedParams(), this function makes an array of the values provided by the user, with the key being the name of the variable, and value - validated value from user or default. | |
| requireOnlyOneParameter ( $params,... $required) | |
| Die if 0 or more than one of a certain set of parameters is set and not false. | |
| requireMaxOneParameter ( $params,... $required) | |
| Dies if more than one parameter from a certain set of parameters are set and not false. | |
| requireAtLeastOneParameter ( $params,... $required) | |
| Die if 0 of a certain set of parameters is set and not false. | |
| requireNoConflictingParameters ( $params, $trigger, $conflicts) | |
| Die with an "invalid param mix" error if the parameters contain the trigger parameter and any of the conflicting parameters. | |
| requirePostedParameters ( $params, $prefix='prefix') | |
| Die if any of the specified parameters were found in the query part of the URL rather than the HTTP post body contents. | |
| getTitleOrPageId ( $params, $load=false) | |
| Attempts to load a WikiPage object from a title or pageid parameter, if possible. | |
| getTitleFromTitleOrPageId ( $params) | |
| Get a Title object from a title or pageid param, if it is possible. | |
| handleParamNormalization ( $paramName, $value, $rawValue) | |
| Handle when a parameter was Unicode-normalized. | |
| validateToken ( $token, array $params) | |
| Validate the supplied token. | |
| getWatchlistUser ( $params) | |
| Gets the user for whom to get the watchlist. | |
| addBlockInfoToStatus (StatusValue $status, ?Authority $user=null) | |
| Add block info to block messages in a Status. | |
| addWarning ( $msg, $code=null, $data=null) | |
| Add a warning for this module. | |
| addDeprecation ( $msg, $feature, $data=[]) | |
| Add a deprecation warning for this module. | |
| addError ( $msg, $code=null, $data=null) | |
| Add an error for this module without aborting. | |
| addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[]) | |
| Add warnings and/or errors from a Status. | |
| dieWithError ( $msg, $code=null, $data=null, $httpCode=0) | |
| Abort execution with an error. | |
| dieWithException (Throwable $exception, array $options=[]) | |
| Abort execution with an error derived from a throwable. | |
| dieBlocked (Block $block) | |
| Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. | |
| dieStatus (StatusValue $status) | |
| Throw an ApiUsageException based on the Status object. | |
| dieReadOnly () | |
| Helper function for readonly errors. | |
| checkUserRightsAny ( $rights) | |
| Helper function for permission-denied errors. | |
| checkTitleUserPermissions (PageIdentity $pageIdentity, $actions, array $options=[]) | |
| Helper function for permission-denied errors. | |
| dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null) | |
| Will only set a warning instead of failing if the global $wgDebugAPI is set to true. | |
| logFeatureUsage ( $feature) | |
| Write logging information for API features to a debug log, for usage analysis. | |
| getFinalSummary () | |
| Get the final module summary. | |
| getFinalDescription () | |
| Get the final module description, after hooks have had a chance to tweak it as needed. | |
| getFinalParams ( $flags=0) | |
| Get the final list of parameters, after hooks have had a chance to tweak it as needed. | |
| getFinalParamDescription () | |
| Get final parameter descriptions, after hooks have had a chance to tweak it as needed. | |
| modifyHelp (array &$help, array $options, array &$tocData) | |
| Called from ApiHelp before the pieces are joined together and returned. | |
| Public Member Functions inherited from MediaWiki\Context\ContextSource | |
| canUseWikiPage () | |
| Check whether a WikiPage object can be get with getWikiPage(). | |
| exportSession () | |
| Export the resolved user IP, HTTP headers, user ID, and session ID. | |
| getActionName () | |
| Get the action name for the current web request. | |
| getAuthority () | |
| getConfig () | |
| getContext () | |
| Get the base IContextSource object. | |
| getCsrfTokenSet () | |
| Get a repository to obtain and match CSRF tokens. | |
| getLanguage () | |
| getLanguageCode () | |
| getOutput () | |
| getRequest () | |
| getSkin () | |
| getTiming () | |
| getTitle () | |
| getUser () | |
| getWikiPage () | |
| Get the WikiPage object. | |
| msg ( $key,... $params) | |
| Get a Message object with context set Parameters are the same as wfMessage() | |
| setContext (IContextSource $context) | |
Protected Member Functions | |
| getExamplesMessages () | |
| Returns usage examples for this module. | |
| Protected Member Functions inherited from MediaWiki\Api\ApiBase | |
| 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. | |
| getWebUITokenSalt (array $params) | |
| Fetch the salt used in the Web UI corresponding to this module. | |
| getDB () | |
| Gets a default replica DB connection object. | |
| getPermissionManager () | |
| Obtain a PermissionManager instance that subclasses may use in their authorization checks. | |
| getHookContainer () | |
| Get a HookContainer, for running extension hooks or for hook metadata. | |
| getHookRunner () | |
| Get an ApiHookRunner for running core API hooks. | |
| getParameter ( $paramName, $parseLimit=true) | |
| Get a value for the given parameter. | |
| getParameterFromSettings ( $name, $settings, $parseLimit) | |
| Using the settings, determine the value for the given parameter. | |
| useTransactionalTimeLimit () | |
| Call wfTransactionalTimeLimit() if this request was POSTed. | |
| filterIDs ( $fields, array $ids) | |
| Filter out-of-range values from a list of positive integer IDs. | |
| parseContinueParamOrDie (string $continue, array $types) | |
| Parse the 'continue' parameter in the usual format and validate the types of each part, or die with the 'badcontinue' error if the format, types, or the number of parts is wrong. | |
| dieContinueUsageIf ( $condition) | |
| Die with the 'badcontinue' error. | |
| getSummaryMessage () | |
| Return the summary message. | |
| getExtendedDescription () | |
| Return the extended help text message. | |
| getHelpFlags () | |
| Generates the list of flags for the help screen and for action=paraminfo. | |
| getModuleSourceInfo () | |
| Returns information about the source of this module, if known. | |
Protected Attributes | |
| WatchlistManager | $watchlistManager |
Additional Inherited Members | |
| Static Public Member Functions inherited from MediaWiki\Api\ApiBase | |
| static | makeMessage ( $msg, IContextSource $context, ?array $params=null) |
| Create a Message from a string or array. | |
| static | clearCacheForTest () |
| Reset static caches of database state. | |
| Public Attributes inherited from MediaWiki\Api\ApiBase | |
| const | PARAM_RANGE_ENFORCE = 'api-param-range-enforce' |
| (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE | |
| const | PARAM_DFLT = ParamValidator::PARAM_DEFAULT |
| const | PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI |
| const | PARAM_TYPE = ParamValidator::PARAM_TYPE |
| const | PARAM_MAX = IntegerDef::PARAM_MAX |
| const | PARAM_MAX2 = IntegerDef::PARAM_MAX2 |
| const | PARAM_MIN = IntegerDef::PARAM_MIN |
| const | PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES |
| const | PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED |
| const | PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED |
| const | PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP |
| const | PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX |
| const | PARAM_ALL = ParamValidator::PARAM_ALL |
| const | PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES |
| const | PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE |
| const | PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES |
| const | PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1 |
| const | PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2 |
| const | PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES |
| const | PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS |
| const | PARAM_HELP_MSG = 'api-param-help-msg' |
| (string|array|Message) Specify an alternative i18n documentation message for this parameter. | |
| const | PARAM_HELP_MSG_APPEND = 'api-param-help-msg-append' |
| ((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. | |
| const | PARAM_HELP_MSG_INFO = 'api-param-help-msg-info' |
| (array) Specify additional information tags for the parameter. | |
| const | PARAM_VALUE_LINKS = 'api-param-value-links' |
| Deprecated and unused. | |
| const | PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value' |
| ((string|array|Message)[]) When PARAM_TYPE is an array, or 'string' with PARAM_ISMULTI, this is an array mapping parameter values to help messages. | |
| const | PARAM_TEMPLATE_VARS = 'param-template-vars' |
| (array) Indicate that this is a templated parameter, and specify replacements. | |
| const | ALL_DEFAULT_STRING = '*' |
| (string|array|Message) Specify an alternative i18n documentation message for this parameter. | |
| const | LIMIT_BIG1 = 500 |
| Fast query, standard limit. | |
| const | LIMIT_BIG2 = 5000 |
| Fast query, apihighlimits limit. | |
| const | LIMIT_SML1 = 50 |
| Slow query, standard limit. | |
| const | LIMIT_SML2 = 500 |
| Slow query, apihighlimits limit. | |
| const | GET_VALUES_FOR_HELP = 1 |
| getAllowedParams() flag: When this is set, the result could take longer to generate, but should be more thorough. | |
| Static Protected Member Functions inherited from MediaWiki\Api\ApiBase | |
| static | dieDebug ( $method, $message) |
| Internal code errors should be reported with this method. | |
Detailed Description
API module to allow users to watch a page.
Definition at line 39 of file ApiWatch.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Api\ApiWatch::__construct | ( | ApiMain | $mainModule, |
| string | $moduleName, | ||
| WatchlistManager | $watchlistManager, | ||
| TitleFormatter | $titleFormatter ) |
Definition at line 52 of file ApiWatch.php.
References MediaWiki\Api\ApiWatch\$watchlistManager, MediaWiki\Context\ContextSource\getConfig(), MediaWiki\MainConfigNames\WatchlistExpiry, and MediaWiki\MainConfigNames\WatchlistExpiryMaxDuration.
Member Function Documentation
◆ execute()
| MediaWiki\Api\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 MediaWiki\Api\ApiBase.
Definition at line 66 of file ApiWatch.php.
References $params, MediaWiki\Api\ApiBase\checkUserRightsAny(), MediaWiki\Api\ApiBase\dieWithError(), MediaWiki\Api\ApiBase\encodeParamName(), MediaWiki\Api\ApiBase\extractRequestParams(), MediaWiki\Api\ApiBase\getModuleName(), MediaWiki\Api\ApiBase\getResult(), MediaWiki\Api\getUser(), MediaWiki\Api\ApiBase\setContinuationManager(), and MediaWiki\Api\ApiResult\setIndexedTagName().
◆ getAllowedParams()
| MediaWiki\Api\ApiWatch::getAllowedParams | ( | $flags = 0 | ) |
Definition at line 196 of file ApiWatch.php.
References MediaWiki\Api\ApiBase\PARAM_HELP_MSG.
◆ getExamplesMessages()
|
protected |
Returns usage examples for this module.
Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.
Do not call this base class implementation when overriding this method.
- Since
- 1.25
- Stability: stable
- to override
- Returns
- array
Reimplemented from MediaWiki\Api\ApiBase.
Definition at line 225 of file ApiWatch.php.
◆ getHelpUrls()
| MediaWiki\Api\ApiWatch::getHelpUrls | ( | ) |
Return links to more detailed help pages about the module.
- Since
- 1.25, returning boolean false is deprecated
- Stability: stable
- to override
- Returns
- string|array
Reimplemented from MediaWiki\Api\ApiBase.
Definition at line 247 of file ApiWatch.php.
◆ isWriteMode()
| MediaWiki\Api\ApiWatch::isWriteMode | ( | ) |
Indicates whether this module requires write access to the wiki.
API modules must override this method to return true if the operation they will perform is not "safe" per RFC 7231 section 4.2.1. A module's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.
Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.
Modules that do not require POST requests should only perform "safe" operations. Note that some modules might require POST requests because they need to support large input parameters and not because they perform non-"safe" operations.
The information provided by this method is used to perform authorization checks. It can also be used to enforce proper routing of supposedly "safe" POST requests to the closest datacenter via the Promise-Non-Write-API-Action header.
- See also
- mustBePosted()
- needsToken()
- Stability: stable
- to override
- Returns
- bool
Reimplemented from MediaWiki\Api\ApiBase.
Definition at line 188 of file ApiWatch.php.
◆ mustBePosted()
| MediaWiki\Api\ApiWatch::mustBePosted | ( | ) |
Indicates whether this module must be called with a POST request.
Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.
- Stability: stable
- to override
- Returns
- bool
Reimplemented from MediaWiki\Api\ApiBase.
Definition at line 184 of file ApiWatch.php.
◆ needsToken()
| MediaWiki\Api\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 force the addition of an appropriate 'token' parameter in self::getFinalParams(). 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.
- Stability: stable
- to override
- Returns
- string|false
Reimplemented from MediaWiki\Api\ApiBase.
Definition at line 192 of file ApiWatch.php.
Member Data Documentation
◆ $watchlistManager
|
protected |
Definition at line 49 of file ApiWatch.php.
Referenced by MediaWiki\Api\ApiWatch\__construct().
The documentation for this class was generated from the following file:
- includes/api/ApiWatch.php
