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

125 lines
3 KiB
PHP

<?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
*/
/**
* An iterator which works exactly like:
*
* foreach ( explode( $delim, $s ) as $element ) {
* ...
* }
*
* Except it doesn't use 193 byte per element
*/
class ExplodeIterator implements Iterator {
/** @var string */
private $subject;
/** @var int */
private $subjectLength;
/** @var string */
private $delim;
/** @var int */
private $delimLength;
/** @var int|false The position of the start of the line */
private $curPos;
/** @var int|false The position after the end of the next delimiter */
private $endPos;
/** @var string|false The current token */
private $current;
/**
* Construct a DelimIterator
* @param string $delim
* @param string $subject
*/
public function __construct( $delim, $subject ) {
$this->subject = $subject;
$this->delim = $delim;
// Micro-optimisation (theoretical)
$this->subjectLength = strlen( $subject );
$this->delimLength = strlen( $delim );
$this->rewind();
}
public function rewind(): void {
$this->curPos = 0;
$this->endPos = strpos( $this->subject, $this->delim );
$this->refreshCurrent();
}
public function refreshCurrent() {
if ( $this->curPos === false ) {
$this->current = false;
} elseif ( $this->curPos >= $this->subjectLength ) {
$this->current = '';
} elseif ( $this->endPos === false ) {
$this->current = substr( $this->subject, $this->curPos );
} else {
$this->current = substr( $this->subject, $this->curPos, $this->endPos - $this->curPos );
}
}
/**
* @return string|false
*/
#[\ReturnTypeWillChange]
public function current() {
return $this->current;
}
/**
* @return int|false Current position or boolean false if invalid
*/
#[\ReturnTypeWillChange]
public function key() {
return $this->curPos;
}
/**
* @return void
*/
public function next(): void {
if ( $this->endPos === false ) {
$this->curPos = false;
} else {
$this->curPos = $this->endPos + $this->delimLength;
if ( $this->curPos >= $this->subjectLength ) {
$this->endPos = false;
} else {
$this->endPos = strpos( $this->subject, $this->delim, $this->curPos );
}
}
$this->refreshCurrent();
}
/**
* @return bool
*/
public function valid(): bool {
return $this->curPos !== false;
}
}