MappedIterator.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Iterators;
 
use ArrayIterator;
use FilterIterator;
use Iterator;
use UnexpectedValueException;
 
class MappedIterator extends FilterIterator {
    protected $vCallback;
    protected $aCallback;
    protected $cache = [];
 
    protected $rewound = false;
 
    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 = ( $this->vCallback )( $inner->current() );
        $ok = ( $this->aCallback ) ? ( $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
        }
    }
 
    protected function init() {
        if ( !$this->rewound ) {
            $this->rewind();
        }
    }
}
 
class_alias( MappedIterator::class, 'MappedIterator' );