ApiQueryMessageGroupStats.php

Go to the documentation of this file.

<?php
class ApiQueryMessageGroupStats extends ApiStatsQuery {
    public function __construct( $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'mgs' );
    }

    protected function getData() {
        $params = $this->extractRequestParams();
        $group = MessageGroups::getGroup( $params['group'] );
        if ( !$group ) {
            $this->dieUsageMsg( array( 'missingparam', 'mcgroup' ) );
        } elseif ( MessageGroups::isDynamic( $group ) ) {
            $this->dieUsage( 'Dynamic message groups are not supported here', 'invalidparam' );
        }

        return MessageGroupStats::forGroup( $group->getId() );
    }

    protected function makeItem( $item, $stats ) {
        $data = parent::makeItem( $item, $stats );
        $data['code'] = $item; // For BC
        $data['language'] = $item;

        return $data;
    }

    public function getAllowedParams() {
        $params = parent::getAllowedParams();
        $params['group'] = array(
            ApiBase::PARAM_TYPE => 'string',
            ApiBase::PARAM_REQUIRED => true,
        );

        return $params;
    }

    public function getParamDescription() {
        $desc = parent::getParamDescription();
        $desc['group'] = 'Message group id';

        return $desc;
    }

    public function getDescription() {
        return 'Query message group stats';
    }

    protected function getExamples() {
        $group = 'page-Example';

        return array(
            "api.php?action=query&meta=messagegroupstats&mgsgroup=$group List of " .
                "translation completion statistics for group $group",
        );
    }
}