);
}
- public function getResultProperties() {
- return array(
- '' => array(
- '*' => array(
- ApiBase::PROP_TYPE => array(
- 'success'
- )
- )
- )
- );
- }
-
public function getParamDescription() {
return array(
'token' => 'An options token previously obtained through the action=tokens',
'reset' => 'Resets preferences to the site defaults',
'resetkinds' => 'List of types of options to reset when the "reset" option is set',
- 'change' => 'List of changes, formatted name=value (e.g. skin=vector), ' .
- 'value cannot contain pipe characters. If no value is given (not ' .
+ 'change' => array( 'List of changes, formatted name=value (e.g. skin=vector), ' .
+ 'value cannot contain pipe characters. If no value is given (not ',
'even an equals sign), e.g., optionname|otheroption|..., the ' .
- 'option will be reset to its default value',
+ 'option will be reset to its default value'
+ ),
'optionname' => 'A name of a option which should have an optionvalue set',
'optionvalue' => 'A value of the option specified by the optionname, ' .
'can contain pipe characters',
public function getDescription() {
return array(
- 'Change preferences of the current user',
+ 'Change preferences of the current user.',
'Only options which are registered in core or in one of installed extensions,',
'or as options with keys prefixed with \'userjs-\' (intended to be used by user',
'scripts), can be set.'
);
}
- public function getPossibleErrors() {
- return array_merge( parent::getPossibleErrors(), array(
- array( 'code' => 'notloggedin', 'info' => 'Anonymous users cannot change preferences' ),
- array( 'code' => 'nochanges', 'info' => 'No changes were requested' ),
- ) );
- }
-
public function needsToken() {
return true;
}