Page MenuHomeWickedGov Phorge
Files F4107163

ApiGlobalPreferenceOverrides.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiGlobalPreferenceOverrides.php
View Options

<?php
namespace GlobalPreferences;
use MediaWiki\Api\ApiMain;
use MediaWiki\Api\ApiOptionsBase;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\User\Options\UserOptionsManager;
class ApiGlobalPreferenceOverrides extends ApiOptionsBase {
private GlobalPreferencesFactory $globalPrefs;
public function __construct(
ApiMain $mainModule,
string $moduleName,
GlobalPreferencesFactory $factory,
UserOptionsManager $userOptionsManager
) {
parent::__construct( $mainModule, $moduleName, $userOptionsManager, $factory );
$this->globalPrefs = $factory;
}
/**
* @inheritDoc
*/
public function execute() {
$user = $this->getUserFromPrimaryOrNull();
if ( $user && !$this->globalPrefs->isUserGlobalized( $user ) ) {
$this->dieWithError( 'apierror-globalpreferences-notglobalized', 'notglobalized' );
}
parent::execute();
}
/**
* @inheritDoc
*/
protected function resetPreferences( array $kinds ) {
$optionNames = array_map(
static fn ( $name ) => $name . UserOptionsLookup::LOCAL_EXCEPTION_SUFFIX,
$this->globalPrefs->getOptionNamesForReset(
$this->getUserFromPrimary(), $this->getContext(), $kinds )
);
$this->getUserOptionsManager()->resetOptionsByName( $this->getUserFromPrimary(), $optionNames );
}
/**
* @inheritDoc
*/
protected function setPreference( $preference, $value ) {
if ( $value === null ) {
$this->getUserOptionsManager()->setOption(
$this->getUserFromPrimary(),
$preference . UserOptionsLookup::LOCAL_EXCEPTION_SUFFIX,
null
);
} else {
$this->getUserOptionsManager()->setOption(
$this->getUserFromPrimary(), $preference, $value, UserOptionsManager::GLOBAL_OVERRIDE );
}
}
/**
* @inheritDoc
*/
protected function commitChanges() {
$this->getUserOptionsManager()->saveOptions( $this->getUserFromPrimary() );
}
/**
* @inheritDoc
*/
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:GlobalPreferences/API';
}
/**
* @inheritDoc
*/
protected function getExamplesMessages() {
return [
'action=globalpreferenceoverrides&reset=&token=123ABC'
=> 'apihelp-globalpreferenceoverrides-example-reset',
'action=globalpreferenceoverrides&change=skin=vector|hideminor=1&token=123ABC'
=> 'apihelp-globalpreferenceoverrides-example-change',
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 19:55 (2 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c8/7f/7d88b43fc17ec2cbfb93bc74c2f9
Default Alt Text
ApiGlobalPreferenceOverrides.php (2 KB)

Event Timeline