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
96
97
98
99
100
101
102
103
104
105
106
|
<?php
/**
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Api;
/**
* @stable to extend
*
* @ingroup API
*/
abstract class ApiQueryGeneratorBase extends ApiQueryBase {
/** @var ApiPageSet|null */
private $mGeneratorPageSet = null;
/**
* Switch this module to generator mode. By default, generator mode is
* switched off and the module acts like a normal query module.
* @since 1.21 requires pageset parameter
* @param ApiPageSet $generatorPageSet ApiPageSet object that the module will get
* by calling getPageSet() when in generator mode.
*/
public function setGeneratorMode( ApiPageSet $generatorPageSet ) {
$this->mGeneratorPageSet = $generatorPageSet;
}
/**
* Indicate whether the module is in generator mode
* @since 1.28
* @return bool
*/
public function isInGeneratorMode() {
return $this->mGeneratorPageSet !== null;
}
/**
* Get the PageSet object to work on.
* If this module is generator, the pageSet object is different from other module's
* @return ApiPageSet
*/
protected function getPageSet() {
return $this->mGeneratorPageSet ?? parent::getPageSet();
}
/**
* Overrides ApiBase to prepend 'g' to every generator parameter
* @param string $paramName Parameter name
* @return string Prefixed parameter name
*/
public function encodeParamName( $paramName ) {
if ( $this->mGeneratorPageSet !== null ) {
return 'g' . parent::encodeParamName( $paramName );
} else {
return parent::encodeParamName( $paramName );
}
}
/**
* Overridden to set the generator param if in generator mode
* @param string $paramName Parameter name
* @param int|string|array $paramValue Parameter value
*/
protected function setContinueEnumParameter( $paramName, $paramValue ) {
if ( $this->mGeneratorPageSet !== null ) {
$this->getContinuationManager()->addGeneratorContinueParam( $this, $paramName, $paramValue );
} else {
parent::setContinueEnumParameter( $paramName, $paramValue );
}
}
/** @inheritDoc */
protected function getHelpFlags() {
// Corresponding messages: api-help-flag-generator
$flags = parent::getHelpFlags();
$flags[] = 'generator';
return $flags;
}
/**
* Execute this module as a generator
* @param ApiPageSet $resultPageSet All output should be appended to this object
*/
abstract public function executeGenerator( $resultPageSet );
}
/** @deprecated class alias since 1.43 */
class_alias( ApiQueryGeneratorBase::class, 'ApiQueryGeneratorBase' );
|
