Page MenuHomeWickedGov Phorge
Files F6002849

ApiGlobalPreferences.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiGlobalPreferences.php
View Options

<?php
namespace GlobalPreferences;
use MediaWiki\Api\ApiMain;
use MediaWiki\Api\ApiOptionsBase;
use MediaWiki\User\Options\UserOptionsManager;
class ApiGlobalPreferences extends ApiOptionsBase {
/** @var mixed[] */
private $prefs = [];
/** @var string[] */
private $resetPrefTypes = [];
/**
* @var GlobalPreferencesFactory
*/
private $factory;
/**
* @param ApiMain $mainModule
* @param string $moduleName
* @param GlobalPreferencesFactory $factory
* @param UserOptionsManager $userOptionsManager
*/
public function __construct(
ApiMain $mainModule,
$moduleName,
GlobalPreferencesFactory $factory,
UserOptionsManager $userOptionsManager
) {
parent::__construct( $mainModule, $moduleName, $userOptionsManager, $factory );
$this->factory = $factory;
}
/**
* @inheritDoc
*/
public function execute() {
$user = $this->getUserForUpdatesOrNull();
if ( $user ) {
$factory = $this->getFactory();
if ( !$factory->isUserGlobalized( $user ) ) {
$this->dieWithError( 'apierror-globalpreferences-notglobalized', 'notglobalized' );
}
}
parent::execute();
}
/**
* @return GlobalPreferencesFactory
*/
private function getFactory() {
return $this->factory;
}
/**
* @inheritDoc
*/
protected function resetPreferences( array $kinds ) {
if ( in_array( 'all', $kinds ) ) {
$this->getFactory()->resetGlobalUserSettings( $this->getUserForUpdates() );
} else {
$this->resetPrefTypes = $kinds;
}
}
/**
* @inheritDoc
*/
protected function setPreference( $preference, $value ) {
$this->prefs[$preference] = $value;
}
/**
* @inheritDoc
*/
protected function commitChanges() {
$factory = $this->getFactory();
$user = $this->getUserForUpdates();
$prefs = $this->getFactory()->getGlobalPreferencesValues( $user, true );
if ( $prefs === false ) {
return;
}
if ( $this->resetPrefTypes ) {
$kinds = $this->getFactory()->getResetKinds(
$this->getUserForUpdates(),
$this->getContext(),
$prefs
);
foreach ( $prefs as $pref => $value ) {
$kind = $kinds[$pref];
if ( in_array( $kind, $this->resetPrefTypes ) ) {
$prefs[$pref] = null;
}
}
}
$prefs = array_merge( $prefs, $this->prefs );
$factory->setGlobalPreferences( $user, $prefs, $this->getContext() );
}
/**
* @inheritDoc
*/
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Globalpreferences';
}
/**
* @inheritDoc
*/
protected function getExamplesMessages() {
return [
'action=globalpreferences&change=skin=&token=123ABC'
=> 'apihelp-globalpreferences-example-reset-one',
'action=globalpreferences&reset=&token=123ABC'
=> 'apihelp-globalpreferences-example-reset',
'action=globalpreferences&change=skin=vector|hideminor=1&token=123ABC'
=> 'apihelp-globalpreferences-example-change',
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Oct 4 2026, 06:58 (5 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
8c/10/982fe052135b79147a243d2f3433
Default Alt Text
ApiGlobalPreferences.php (2 KB)

Event Timeline