IteratorDecorator.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

IteratorDecorator.php
View Options

	<?php

	/**
	* @license GPL-2.0-or-later
	*/

	/**
	* Allows extending classes to decorate an Iterator with
	* reduced boilerplate.
	*
	* @stable to extend
	* @ingroup Maintenance
	*/
	abstract class IteratorDecorator implements Iterator {
	protected Iterator $iterator;

	/**
	* @stable to call
	*
	* @param Iterator $iterator
	*/
	public function __construct( Iterator $iterator ) {
	$this->iterator = $iterator;
	}

	/**
	* @inheritDoc
	* @stable to override
	*/
	#[\ReturnTypeWillChange]
	public function current() {
	return $this->iterator->current();
	}

	/**
	* @inheritDoc
	* @stable to override
	*/
	#[\ReturnTypeWillChange]
	public function key() {
	return $this->iterator->key();
	}

	/**
	* @inheritDoc
	* @stable to override
	*/
	public function next(): void {
	$this->iterator->next();
	}

	/**
	* @inheritDoc
	* @stable to override
	*/
	public function rewind(): void {
	$this->iterator->rewind();
	}

	/**
	* @inheritDoc
	* @stable to override
	*/
	public function valid(): bool {
	return $this->iterator->valid();
	}
	}