Page MenuHomeWickedGov Phorge
Files F4096588

ApiQueryGlobalPreferences.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiQueryGlobalPreferences.php
View Options

<?php
namespace GlobalPreferences;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiQuery;
use MediaWiki\Api\ApiQueryBase;
use MediaWiki\Api\ApiResult;
use MediaWiki\User\Options\UserOptionsLookup;
use Wikimedia\ParamValidator\ParamValidator;
class ApiQueryGlobalPreferences extends ApiQueryBase {
/**
* @var GlobalPreferencesFactory
*/
private $preferencesFactory;
/**
* @var UserOptionsLookup
*/
private $userOptionsLookup;
/**
* @param ApiQuery $queryModule
* @param string $moduleName
* @param GlobalPreferencesFactory $factory
* @param UserOptionsLookup $userOptionsLookup
*/
public function __construct(
ApiQuery $queryModule,
$moduleName,
GlobalPreferencesFactory $factory,
UserOptionsLookup $userOptionsLookup
) {
parent::__construct( $queryModule, $moduleName, 'gpr' );
$this->preferencesFactory = $factory;
$this->userOptionsLookup = $userOptionsLookup;
}
/**
* @inheritDoc
*/
public function execute() {
if ( !$this->getUser()->isNamed() ) {
$this->dieWithError(
[ 'apierror-mustbeloggedin', $this->msg( 'action-editmyoptions' ) ], 'notloggedin'
);
}
if ( !$this->preferencesFactory->isUserGlobalized( $this->getUser() ) ) {
$this->dieWithError( 'apierror-globalpreferences-notglobalized', 'notglobalized' );
}
$params = $this->extractRequestParams();
$prop = array_flip( $params['prop'] );
$result = [];
ApiResult::setArrayType( $result, 'assoc' );
if ( isset( $prop['preferences'] ) ) {
$prefs = $this->preferencesFactory->getGlobalPreferencesValues( $this->getUser() );
$result['preferences'] = $prefs;
ApiResult::setArrayType( $result['preferences'], 'assoc' );
}
if ( isset( $prop['localoverrides'] ) ) {
$overriddenPrefs = [];
$userOptions = $this->userOptionsLookup->getOptions( $this->getUser() );
foreach ( $userOptions as $pref => $value ) {
if ( GlobalPreferencesFactory::isLocalPrefName( $pref ) ) {
$mainPref = substr( $pref, 0,
-strlen( UserOptionsLookup::LOCAL_EXCEPTION_SUFFIX ) );
if ( isset( $userOptions[$mainPref] ) ) {
$overriddenPrefs[$mainPref] = $userOptions[$mainPref];
}
}
}
$result['localoverrides'] = $overriddenPrefs;
ApiResult::setArrayType( $result['localoverrides'], 'assoc' );
}
$this->getResult()->addValue( 'query', $this->getModuleName(), $result );
}
/**
* @inheritDoc
*/
public function getAllowedParams() {
return [
'prop' => [
ParamValidator::PARAM_TYPE => [
'preferences',
'localoverrides',
],
ParamValidator::PARAM_ISMULTI => true,
ParamValidator::PARAM_DEFAULT => 'preferences|localoverrides',
ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
],
];
}
/**
* @inheritDoc
*/
public function getHelpUrls() {
return [ 'https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:GlobalPreferences/API' ];
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 14:24 (3 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
4c/73/a3a28f3afa124ac40c1051b8f563
Default Alt Text
ApiQueryGlobalPreferences.php (2 KB)

Event Timeline