Go to the documentation of this file.
40 if (
$user->isAnon() ) {
41 $this->
dieUsage(
'Anonymous users cannot change preferences',
'notloggedin' );
44 if ( !
$user->isAllowed(
'editmyoptions' ) ) {
45 $this->
dieUsage(
'You don\'t have permission to edit your options',
'permissiondenied' );
51 if ( isset(
$params[
'optionvalue'] ) && !isset(
$params[
'optionname'] ) ) {
61 if ( count(
$params[
'change'] ) ) {
63 $array = explode(
'=', $entry, 2 );
64 $changes[$array[0]] = isset( $array[1] ) ? $array[1] :
null;
67 if ( isset(
$params[
'optionname'] ) ) {
68 $newValue = isset(
$params[
'optionvalue'] ) ?
$params[
'optionvalue'] :
null;
69 $changes[
$params[
'optionname']] = $newValue;
71 if ( !
$changed && !count( $changes ) ) {
72 $this->
dieUsage(
'No changes were requested',
'nochanges' );
78 foreach ( $changes
as $key =>
$value ) {
79 switch ( $prefsKinds[$key] ) {
83 $validation = $field->validate(
$value,
$user->getOptions() );
85 case 'registered-multiselect':
86 case 'registered-checkmatrix':
93 if ( strlen( $key ) > 255 ) {
94 $validation =
"key too long (no more than 255 bytes allowed)";
95 } elseif ( preg_match(
"/[^a-zA-Z0-9_-]/", $key ) !== 0 ) {
96 $validation =
"invalid key (only a-z, A-Z, 0-9, _, - allowed)";
102 $validation =
"cannot be set by this module";
106 $validation =
"not a valid preference";
109 if ( $validation ===
true ) {
113 $this->
setWarning(
"Validation error for '$key': $validation" );
119 $user->saveSettings();
135 $optionKinds[] =
'all';
143 'resetkinds' =>
array(
151 'optionname' =>
array(
154 'optionvalue' =>
array(
174 'token' =>
'An options token previously obtained through the action=tokens',
175 'reset' =>
'Resets preferences to the site defaults',
176 'resetkinds' =>
'List of types of options to reset when the "reset" option is set',
177 'change' =>
array(
'List of changes, formatted name=value (e.g. skin=vector), ' .
178 'value cannot contain pipe characters. If no value is given (not ',
179 'even an equals sign), e.g., optionname|otheroption|..., the ' .
180 'option will be reset to its default value'
182 'optionname' =>
'A name of a option which should have an optionvalue set',
183 'optionvalue' =>
'A value of the option specified by the optionname, ' .
184 'can contain pipe characters',
190 'Change preferences of the current user.',
191 'Only options which are registered in core or in one of installed extensions,',
192 'or as options with keys prefixed with \'userjs-\' (intended to be used by user',
193 'scripts), can be set.'
198 return array_merge( parent::getPossibleErrors(),
array(
199 array(
'code' =>
'notloggedin',
'info' =>
'Anonymous users cannot change preferences' ),
200 array(
'code' =>
'nochanges',
'info' =>
'No changes were requested' ),
213 return 'https://www.mediawiki.org/wiki/API:Options';
218 'api.php?action=options&reset=&token=123ABC',
219 'api.php?action=options&change=skin=vector|hideminor=1&token=123ABC',
220 'api.php?action=options&reset=&change=skin=monobook&optionname=nickname&' .
221 'optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC',
static getPreferences( $user, IContextSource $context)
getContext()
Get the RequestContext object.
getDescription()
Returns the description string for this module.
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
isWriteMode()
Indicates whether this module requires write mode.
dieUsageMsg( $error)
Output the error message related to a certain array.
getResult()
Get the result object.
getUser()
Get the User object.
getExamples()
Returns usage examples for this module.
This abstract class implements many basic API functions, and is the base of all API classes.
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
execute()
Changes preferences of the current user.
mustBePosted()
Indicates whether this module must be called with a POST request.
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
API module that facilitates the changing of user's preferences.
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
needsToken()
Returns whether this module requires a token to execute It is used to show possible errors in action=...
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
getPossibleErrors()
Returns a list of all possible errors returned by the module.
getTokenSalt()
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the mo...
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
getParamDescription()
Returns an array of parameter descriptions.
setWarning( $warning)
Set warning section for this module.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
getModuleName()
Get the name of the module being executed by this instance.
static listOptionKinds()
Return a list of the types of user options currently returned by User::getOptionKinds().