Your IP : 18.191.237.194
<?php
namespace RebelCode\Wpra\Core\Util;
use Iterator;
use Traversable;
/**
* Functionality for objects that need to implement the {@link Iterator} interface but wish to delegate the actual
* iteration to another iterator.
*
* @since 4.13
*/
trait IteratorDelegateTrait
{
/**
* Internal temporary iterator, used during iteration.
*
* @since 4.13
*
* @var Iterator|null
*/
protected $_iterator;
/**
* Retrieves the inner iterator to use for iteration.
*
* @since 4.13
*
* @return Iterator|null
*/
abstract protected function getIterator();
/**
* Returns whether or not iterators values should be unpacked in to arrays during iteration.
*
* @since 4.13
*
* @return bool True to unpack iterator values, false to leave them as iterator instances.
*/
protected function recursiveUnpackIterators()
{
return false;
}
/**
* Processes a value that needs to be yielded during iteration.
*
* @since 4.13
*
* @param mixed $value The value.
*
* @return mixed
*/
protected function yieldIterationValue($value)
{
if ($this->recursiveUnpackIterators() && $value instanceof Traversable) {
return iterator_to_array($value);
}
return $this->createIterationValue($value);
}
/**
* Creates an iteration value.
*
* @since 4.13
*
* @param mixed value The original iteration value.
*
* @return mixed The new iteration value.
*/
protected function createIterationValue($value)
{
return $value;
}
/**
* Rewinds the iterator.
*
* @since 4.13
*/
public function rewind()
{
$this->_iterator = $this->getIterator();
if ($this->_iterator !== null) {
$this->_iterator->rewind();
}
}
/**
* Advances the iterator onto the next element.
*
* @since 4.13
*/
public function next()
{
$this->_iterator->next();
}
/**
* Retrieves the current iteration key.
*
* @since 4.13
*
* @return mixed
*/
public function key()
{
return $this->_iterator->key();
}
/**
* Retrieves the current iteration value.
*
* Consumers that override this method are encourage to pass the value through {@link yieldValue} before
* returning it.
*
* @since 4.13
*
* @return mixed
*/
public function current()
{
return $this->yieldIterationValue($this->_iterator->current());
}
/**
* Checks if the iterator has more elements to yield.
*
* @since 4.13
*
* @return bool
*/
public function valid()
{
return $this->_iterator !== null && $this->_iterator->valid();
}
}