summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/Translate/api/ApiQueryMessageGroupStats.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/extensions/Translate/api/ApiQueryMessageGroupStats.php')
-rw-r--r--www/wiki/extensions/Translate/api/ApiQueryMessageGroupStats.php63
1 files changed, 63 insertions, 0 deletions
diff --git a/www/wiki/extensions/Translate/api/ApiQueryMessageGroupStats.php b/www/wiki/extensions/Translate/api/ApiQueryMessageGroupStats.php
new file mode 100644
index 00000000..3f9ea6c4
--- /dev/null
+++ b/www/wiki/extensions/Translate/api/ApiQueryMessageGroupStats.php
@@ -0,0 +1,63 @@
+<?php
+/**
+ * Api module for querying message group stats.
+ *
+ * @file
+ * @author Tim Gerundt
+ * @author Niklas Laxström
+ * @copyright Copyright © 2012-2013, Tim Gerundt
+ * @license GPL-2.0-or-later
+ */
+
+/**
+ * Api module for querying message group stats.
+ *
+ * @ingroup API TranslateAPI
+ */
+class ApiQueryMessageGroupStats extends ApiStatsQuery {
+ public function __construct( $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'mgs' );
+ }
+
+ /// Overwritten from ApiStatsQuery
+ protected function validateTargetParamater( array $params ) {
+ $group = MessageGroups::getGroup( $params['group'] );
+ if ( !$group ) {
+ $this->dieWithError( [ 'apierror-missingparam', 'mgsgroup' ] );
+ } elseif ( MessageGroups::isDynamic( $group ) ) {
+ $this->dieWithError( 'apierror-translate-nodynamicgroups', 'invalidparam' );
+ }
+
+ return $group->getId();
+ }
+
+ /// Overwritten from ApiStatsQuery
+ protected function loadStatistics( $target, $flags = 0 ) {
+ return MessageGroupStats::forGroup( $target, $flags );
+ }
+
+ 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'] = [
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_REQUIRED => true,
+ ];
+
+ return $params;
+ }
+
+ protected function getExamplesMessages() {
+ return [
+ 'action=query&meta=messagegroupstats&mgsgroup=page-Example'
+ => 'apihelp-query+messagegroupstats-example-1',
+ ];
+ }
+}