wiki.techinc.nl/includes/TitleArrayFromResult.php
Aryeh Gregor c435212260 Get rid of warnings on PHP 8.1
This is mostly about adding return types to methods that implement PHP
interfaces, and not passing null to core functions that want a string.
After this patch, and an update to return types in RemexHtml,
tests/phpunit/integration/ has no more errors than in PHP 8.0.

Bug: T289879
Bug: T289926
Change-Id: Ia424f5cc897070f4188ae126b5bf6a1f552db0e1
2022-06-13 04:42:20 -04:00

100 lines
2.3 KiB
PHP

<?php
/**
* Class to walk into a list of Title objects.
*
* Note: this entire file is a byte-for-byte copy of UserArrayFromResult.php
* with s/User/Title/. If anyone can figure out how to do this nicely
* with inheritance or something, please do so.
*
* 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
*/
use Wikimedia\Rdbms\IResultWrapper;
/**
* @newable
* @note marked as newable in 1.35 for lack of a better alternative,
* but should probably become part of the TitleFactory service.
*/
class TitleArrayFromResult extends TitleArray implements Countable {
/** @var IResultWrapper */
public $res;
/** @var int */
public $key;
/** @var Title|false */
public $current;
/**
* @stable to call
*
* @param IResultWrapper $res
*/
public function __construct( $res ) {
$this->res = $res;
$this->key = 0;
$this->setCurrent( $this->res->current() );
}
/**
* @param bool|stdClass $row
* @return void
*/
protected function setCurrent( $row ) {
if ( $row === false ) {
$this->current = false;
} else {
$this->current = Title::newFromRow( $row );
}
}
/**
* @return int
*/
public function count(): int {
return $this->res->numRows();
}
public function current(): Title {
return $this->current;
}
public function key(): int {
return $this->key;
}
public function next(): void {
$row = $this->res->fetchObject();
$this->setCurrent( $row );
$this->key++;
}
public function rewind(): void {
$this->res->rewind();
$this->key = 0;
$this->setCurrent( $this->res->current() );
}
/**
* @return bool
*/
public function valid(): bool {
return $this->current !== false;
}
}