QueryLanguageStatsActionApi.php

<?php
declare( strict_types = 1 );
 
namespace MediaWiki\Extension\Translate\Statistics;
 
use ApiQuery;
use IJobSpecification;
use JobQueueGroup;
use MessageGroups;
use MessageGroupStats;
use MessageGroupStatsRebuildJob;
use TranslateUtils;
use Wikimedia\ParamValidator\ParamValidator;
 
class QueryLanguageStatsActionApi extends QueryStatsActionApi {
    public function __construct(
        ApiQuery $query,
        string $moduleName,
        JobQueueGroup $jobQueueGroup
    ) {
        parent::__construct( $query, $moduleName, 'ls', $jobQueueGroup );
    }
 
    // ApiStatsQuery methods
 
    protected function validateTargetParamater( array $params ): string {
        $requested = $params[ 'language' ];
        if ( !TranslateUtils::isSupportedLanguageCode( $requested ) ) {
            $this->dieWithError( [ 'apierror-translate-invalidlanguage', $requested ] );
        }
 
        return $requested;
    }
 
    protected function loadStatistics( string $target, int $flags = 0 ): array {
        $groupId = $this->getParameter( 'group' );
        $group = $groupId !== null ? MessageGroups::getGroup( $groupId ) : null;
        if ( $groupId ) {
            if ( !$group ) {
                $this->dieWithError( [ 'apierror-badparameter', 'group' ] );
            }
 
            return [ $groupId => MessageGroupStats::forItem( $group->getId(), $target, $flags ) ];
        } else {
            return MessageGroupStats::forLanguage( $target, $flags );
        }
    }
 
    protected function makeStatsItem( string $item, array $stats ): array {
        $data = $this->makeItem( $stats );
        $data['group'] = $item;
 
        return $data;
    }
 
    protected function getCacheRebuildJob( string $target ): IJobSpecification {
        return MessageGroupStatsRebuildJob::newJob( [ 'languagecode' => $target ] );
    }
 
    // Api methods
 
    protected function getAllowedParams(): array {
        $params = parent::getAllowedParams();
        $params['language'] = [
            ParamValidator::PARAM_TYPE => 'string',
            ParamValidator::PARAM_REQUIRED => true,
        ];
 
        $params['group'] = [
            ParamValidator::PARAM_TYPE => 'string',
        ];
 
        return $params;
    }
 
    protected function getExamplesMessages(): array {
        return [
            'action=query&meta=languagestats&lslanguage=fi'
                => 'apihelp-query+languagestats-example-1',
            'action=query&meta=languagestats&lslanguage=fi&group=A'
                => 'apihelp-query+languagestats-example-2'
        ];
    }
}