aboutsummaryrefslogtreecommitdiffstats
path: root/includes/user/UserArrayFromResult.php
blob: 611449152dbfc05c5aa2e74e44604b0d2bca1126 (plain) (blame)
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
<?php
/**
 * 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\User;

use stdClass;
use Wikimedia\Rdbms\IResultWrapper;

/**
 * @internal Call and type against UserArray instead.
 */
class UserArrayFromResult extends UserArray {

	private IResultWrapper $res;
	private int $key = 0;
	/** FIXME not private because CentralAuth is extending this class when it shouldn't. See T387148 */
	protected ?User $current = null;

	public function __construct( IResultWrapper $res ) {
		$this->res = $res;
		$this->rewind();
	}

	/**
	 * @param stdClass|null|false $row
	 * @return void
	 */
	protected function setCurrent( $row ) {
		$this->current = $row instanceof stdClass ? User::newFromRow( $row ) : null;
	}

	public function count(): int {
		return $this->res->numRows();
	}

	public function current(): User {
		return $this->current;
	}

	public function key(): int {
		return $this->key;
	}

	public function next(): void {
		$this->setCurrent( $this->res->fetchObject() );
		$this->key++;
	}

	public function rewind(): void {
		$this->res->rewind();
		$this->key = 0;
		$this->setCurrent( $this->res->current() );
	}

	public function valid(): bool {
		return (bool)$this->current;
	}
}

/** @deprecated class alias since 1.41 */
class_alias( UserArrayFromResult::class, 'UserArrayFromResult' );