Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 4 |
CRAP | |
71.88% |
23 / 32 |
| ApiQueryGlobalPreferences | |
0.00% |
0 / 1 |
|
0.00% |
0 / 4 |
13.69 | |
71.88% |
23 / 32 |
| __construct | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 4 |
|||
| execute | |
0.00% |
0 / 1 |
8.10 | |
88.46% |
23 / 26 |
|||
| getAllowedParams | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| getHelpUrls | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| <?php | |
| namespace GlobalPreferences; | |
| use ApiBase; | |
| use ApiQuery; | |
| use ApiQueryBase; | |
| use ApiResult; | |
| use MediaWiki\User\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()->isRegistered() ) { | |
| $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( GlobalPreferencesFactory::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' ]; | |
| } | |
| } |