ApiQueryOATH.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Extension\OATHAuth\Api\Module;
 
use MediaWiki\MediaWikiServices;
use ApiQueryBase;
use ApiBase;
use ApiResult;
use User;
 
class ApiQueryOATH extends ApiQueryBase {
    public function __construct( $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'oath' );
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
        if ( $params['user'] === null ) {
            $params['user'] = $this->getUser()->getName();
        }
 
        $this->checkUserRightsAny( 'oathauth-api-all' );
 
        $user = User::newFromName( $params['user'] );
        if ( $user === false ) {
            $this->dieWithError( 'noname' );
        }
 
        $result = $this->getResult();
        $data = [
            ApiResult::META_BC_BOOLS => [ 'enabled' ],
            'enabled' => false,
        ];
 
        if ( !$user->isAnon() ) {
            $userRepo = MediaWikiServices::getInstance()->getService( 'OATHUserRepository' );
            $authUser = $userRepo->findByUser( $user );
            $data['enabled'] = $authUser &&
                $authUser->getModule() !== null &&
                $authUser->getModule()->isEnabled( $authUser );
        }
        $result->addValue( 'query', $this->getModuleName(), $data );
    }
 
    public function getCacheMode( $params ) {
        return 'private';
    }
 
    public function isInternal() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'user' => [
                ApiBase::PARAM_TYPE => 'user',
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=query&meta=oath'
                => 'apihelp-query+oath-example-1',
            'action=query&meta=oath&oathuser=Example'
                => 'apihelp-query+oath-example-2',
        ];
    }
}