API module that facilitates the changing of user's preferences. More...
Public Member Functions | |
| execute () | |
| Changes preferences of the current user. | |
| 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. | |
| 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. | |
Detailed Description
API module that facilitates the changing of user's preferences.
Requires API write mode to be enabled.
Definition at line 33 of file ApiOptions.php.
Member Function Documentation
Changes preferences of the current user.
Reimplemented from ApiBase.
Definition at line 37 of file ApiOptions.php.
References $changed, $key, $params, $user, $value, array(), as, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ContextSource\getContext(), ApiBase\getModuleName(), Preferences\getPreferences(), ApiBase\getResult(), ContextSource\getUser(), HTMLForm\loadInputFromParameters(), and ApiBase\setWarning().
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.
Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.
- Returns:
- array|bool
Reimplemented from ApiBase.
Definition at line 133 of file ApiOptions.php.
References array(), User\listOptionKinds(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- string|array
Reimplemented from ApiBase.
Definition at line 171 of file ApiOptions.php.
References array().
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 188 of file ApiOptions.php.
References array().
- 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 184 of file ApiOptions.php.
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 156 of file ApiOptions.php.
References array().
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 129 of file ApiOptions.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 125 of file ApiOptions.php.
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 180 of file ApiOptions.php.
The documentation for this class was generated from the following file:
- includes/api/ApiOptions.php
