wiki.techinc.nl/includes/libs/ReverseArrayIterator.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

79 lines
2.1 KiB
PHP

<?php
/**
* Convenience class for iterating over an array in reverse order.
*
* 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
* @since 1.27
*/
/**
* Convenience class for iterating over an array in reverse order.
*
* @since 1.27
*/
class ReverseArrayIterator implements Iterator, Countable {
/** @var array */
protected $array;
/**
* Creates an iterator which will visit the keys in $array in
* reverse order. If given an object, will visit the properties
* of the object in reverse order. (Note that the default order
* for PHP arrays and objects is declaration/assignment order.)
*
* @phpcs:ignore MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam
* @param array|object $array
*/
public function __construct( $array = [] ) {
if ( is_array( $array ) ) {
$this->array = $array;
} elseif ( is_object( $array ) ) {
$this->array = get_object_vars( $array );
} else {
throw new InvalidArgumentException( __METHOD__ . ' requires an array or object' );
}
$this->rewind();
}
#[\ReturnTypeWillChange]
public function current() {
return current( $this->array );
}
#[\ReturnTypeWillChange]
public function key() {
return key( $this->array );
}
public function next(): void {
prev( $this->array );
}
public function rewind(): void {
end( $this->array );
}
public function valid(): bool {
return key( $this->array ) !== null;
}
public function count(): int {
return count( $this->array );
}
}