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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?php
/**
* Holders of revision list for a single page
*
* 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\RevisionList;
use Iterator;
use MediaWiki\Context\ContextSource;
use MediaWiki\Context\IContextSource;
use MediaWiki\Debug\DeprecationHelper;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Title\Title;
use stdClass;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\IResultWrapper;
/**
* List for revision table items for a single page
*/
abstract class RevisionListBase extends ContextSource implements Iterator {
use DeprecationHelper;
/** @var PageIdentity */
protected $page;
/** @var int[]|null */
protected $ids;
/** @var IResultWrapper|false */
protected $res;
/** @var RevisionItemBase|false */
protected $current;
/**
* Construct a revision list for a given page identity
* @param IContextSource $context
* @param PageIdentity $page
*/
public function __construct( IContextSource $context, PageIdentity $page ) {
$this->setContext( $context );
$this->page = $page;
$this->deprecatePublicPropertyFallback(
'title',
'1.37',
function (): Title {
return Title::newFromPageIdentity( $this->page );
},
function ( PageIdentity $page ) {
$this->page = $page;
}
);
}
/**
* @return PageIdentity
*/
public function getPage(): PageIdentity {
return $this->page;
}
/**
* @internal for use by RevDelItems
* @return string
*/
public function getPageName(): string {
return Title::newFromPageIdentity( $this->page )->getPrefixedText();
}
/**
* Select items only where the ID is any of the specified values
* @param int[] $ids
*/
public function filterByIds( array $ids ) {
$this->ids = $ids;
}
/**
* Get the internal type name of this list. Equal to the table name.
* Override this function.
* @return string|null
*/
public function getType() {
return null;
}
/**
* Initialise the current iteration pointer
*/
protected function initCurrent() {
$row = $this->res->current();
if ( $row ) {
$this->current = $this->newItem( $row );
} else {
$this->current = false;
}
}
/**
* Start iteration. This must be called before current() or next().
* @return RevisionItemBase First list item
*/
public function reset() {
if ( !$this->res ) {
$this->res = $this->doQuery(
MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase()
);
} else {
$this->res->rewind();
}
$this->initCurrent();
return $this->current;
}
public function rewind(): void {
$this->reset();
}
/**
* Get the current list item, or false if we are at the end
* @return RevisionItemBase|false
*/
#[\ReturnTypeWillChange]
public function current() {
return $this->current;
}
/**
* Move the iteration pointer to the next list item, and return it.
* @return RevisionItemBase
* @suppress PhanParamSignatureMismatchInternal
*/
#[\ReturnTypeWillChange]
public function next() {
$this->res->next();
$this->initCurrent();
return $this->current;
}
public function key(): int {
return $this->res ? $this->res->key() : 0;
}
public function valid(): bool {
return $this->res && $this->res->valid();
}
/**
* Get the number of items in the list.
* @return int
*/
public function length() {
if ( !$this->res ) {
return 0;
} else {
return $this->res->numRows();
}
}
/**
* Do the DB query to iterate through the objects.
* @param IReadableDatabase $db DB object to use for the query
* @return IResultWrapper
*/
abstract public function doQuery( $db );
/**
* Create an item object from a DB result row
* @param stdClass $row
* @return RevisionItemBase
*/
abstract public function newItem( $row );
}
/** @deprecated class alias since 1.43 */
class_alias( RevisionListBase::class, 'RevisionListBase' );
|
