da63db52af
Add doc-typehints to class properties found by the PropertyDocumentation sniff to improve the documentation. Once the sniff is enabled it avoids that new code is missing type declarations. This is focused on documentation and does not change code. Change-Id: I46f46f1855ca32c89a276b06f4e2051ff541886e
122 lines
3.4 KiB
PHP
122 lines
3.4 KiB
PHP
<?php
|
|
/**
|
|
* Convenience class for generating iterators from iterators.
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
/**
|
|
* Convenience class for generating iterators from iterators.
|
|
*
|
|
* @since 1.21
|
|
*/
|
|
class MappedIterator extends FilterIterator {
|
|
/** @var callable */
|
|
protected $vCallback;
|
|
/** @var callable|null */
|
|
protected $aCallback;
|
|
/** @var array */
|
|
protected $cache = [];
|
|
|
|
/** @var bool whether rewind() has been called */
|
|
protected $rewound = false;
|
|
|
|
/**
|
|
* Build a new iterator from a base iterator by having the former wrap the
|
|
* later, returning the result of "value" callback for each current() invocation.
|
|
* The callback takes the result of current() on the base iterator as an argument.
|
|
* The keys of the base iterator are reused verbatim.
|
|
*
|
|
* An "accept" callback can also be provided which will be called for each value in
|
|
* the base iterator (post-callback) and will return true if that value should be
|
|
* included in iteration of the MappedIterator (otherwise it will be filtered out).
|
|
*
|
|
* @param Iterator|array $iter
|
|
* @param callable $vCallback Value transformation callback
|
|
* @param array $options Options map (includes "accept") (since 1.22)
|
|
* @phan-param array{accept?:callable} $options
|
|
* @throws UnexpectedValueException
|
|
*/
|
|
public function __construct( $iter, $vCallback, array $options = [] ) {
|
|
if ( is_array( $iter ) ) {
|
|
$baseIterator = new ArrayIterator( $iter );
|
|
} elseif ( $iter instanceof Iterator ) {
|
|
$baseIterator = $iter;
|
|
} else {
|
|
throw new UnexpectedValueException( "Invalid base iterator provided." );
|
|
}
|
|
parent::__construct( $baseIterator );
|
|
$this->vCallback = $vCallback;
|
|
$this->aCallback = $options['accept'] ?? null;
|
|
}
|
|
|
|
public function next(): void {
|
|
$this->cache = [];
|
|
parent::next();
|
|
}
|
|
|
|
public function rewind(): void {
|
|
$this->rewound = true;
|
|
$this->cache = [];
|
|
parent::rewind();
|
|
}
|
|
|
|
public function accept(): bool {
|
|
$inner = $this->getInnerIterator();
|
|
'@phan-var Iterator $inner';
|
|
$value = call_user_func( $this->vCallback, $inner->current() );
|
|
$ok = ( $this->aCallback ) ? call_user_func( $this->aCallback, $value ) : true;
|
|
if ( $ok ) {
|
|
$this->cache['current'] = $value;
|
|
}
|
|
|
|
return $ok;
|
|
}
|
|
|
|
#[\ReturnTypeWillChange]
|
|
public function key() {
|
|
$this->init();
|
|
|
|
return parent::key();
|
|
}
|
|
|
|
public function valid(): bool {
|
|
$this->init();
|
|
|
|
return parent::valid();
|
|
}
|
|
|
|
#[\ReturnTypeWillChange]
|
|
public function current() {
|
|
$this->init();
|
|
if ( parent::valid() ) {
|
|
return $this->cache['current'];
|
|
} else {
|
|
return null; // out of range
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Obviate the usual need for rewind() before using a FilterIterator in a manual loop
|
|
*/
|
|
protected function init() {
|
|
if ( !$this->rewound ) {
|
|
$this->rewind();
|
|
}
|
|
}
|
|
}
|