1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<?php
/**
* A base module for querying message group related stats.
*
* @file
* @author Niklas Laxström
* @license GPL-2.0-or-later
*/
/**
* A base module for querying message group related stats.
*
* @ingroup API TranslateAPI
* @since 2012-11-30
*/
abstract class ApiStatsQuery extends ApiQueryBase {
public function getCacheMode( $params ) {
return 'public';
}
/**
* Implement this to implement input validation and return the name of the target that
* is then given to loadStats.
* @param array $params
* @return string
*/
abstract protected function validateTargetParamater( array $params );
/**
* Implement this to load stats.
* @param string $target
* @param int $flags See MessageGroupStats for possible flags
* @return array[]
*/
abstract protected function loadStatistics( $target, $flags = 0 );
public function execute() {
$params = $this->extractRequestParams();
$target = $this->validateTargetParamater( $params );
$cache = $this->loadStatistics( $target, MessageGroupStats::FLAG_CACHE_ONLY );
$result = $this->getResult();
$incomplete = false;
foreach ( $cache as $item => $stats ) {
if ( $item < $params['offset'] ) {
continue;
}
if ( $stats[MessageGroupStats::TOTAL] === null ) {
$incomplete = true;
$this->setContinueEnumParameter( 'offset', $item );
break;
}
$data = $this->makeItem( $item, $stats );
$result->addValue( [ 'query', $this->getModuleName() ], null, $data );
}
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'stats' );
if ( $incomplete ) {
DeferredUpdates::addCallableUpdate( function () use ( $target ) {
$this->loadStatistics( $target );
} );
}
}
protected function makeItem( $item, $stats ) {
return [
'total' => $stats[MessageGroupStats::TOTAL],
'translated' => $stats[MessageGroupStats::TRANSLATED],
'fuzzy' => $stats[MessageGroupStats::FUZZY],
'proofread' => $stats[MessageGroupStats::PROOFREAD],
];
}
public function getAllowedParams() {
return [
'offset' => [
ApiBase::PARAM_DFLT => '0',
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
'timelimit' => [
ApiBase::PARAM_DFLT => 8,
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_MAX => 10,
ApiBase::PARAM_MIN => 0,
ApiBase::PARAM_DEPRECATED => true, // Since 2018.10
],
];
}
}
|
