gnu-social/vendor/hoa/iterator/Lookahead.php

<?php

/**
 * Hoa
 *
 *
 * @license
 *
 * New BSD License
 *
 * Copyright © 2007-2017, Hoa community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Hoa nor the names of its contributors may be
 *       used to endorse or promote products derived from this software without
 *       specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

namespace Hoa\Iterator;

/**
 * Class \Hoa\Iterator\Lookahead.
 *
 * Look ahead iterator.
 *
 * @copyright  Copyright © 2007-2017 Hoa community
 * @license    New BSD License
 */
class Lookahead extends IteratorIterator implements Outer
{
    /**
     * Current iterator.
     *
     * @var \Iterator
     */
    protected $_iterator = null;

    /**
     * Current key.
     *
     * @var mixed
     */
    protected $_key      = 0;

    /**
     * Current value.
     *
     * @var mixed
     */
    protected $_current  = null;

    /**
     * Whether the current element is valid or not.
     *
     * @var bool
     */
    protected $_valid    = false;



    /**
     * Construct.
     *
     * @param   \Iterator  $iterator    Iterator.
     */
    public function __construct(\Iterator $iterator)
    {
        $this->_iterator = $iterator;

        return;
    }

    /**
     * Get inner iterator.
     *
     * @return  \Iterator
     */
    public function getInnerIterator()
    {
        return $this->_iterator;
    }

    /**
     * Return the current element.
     *
     * @return  mixed
     */
    public function current()
    {
        return $this->_current;
    }

    /**
     * Return the key of the current element.
     *
     * @return  mixed
     */
    public function key()
    {
        return $this->_key;
    }

    /**
     * Move forward to next element.
     *
     * @return  void
     */
    public function next()
    {
        $innerIterator = $this->getInnerIterator();
        $this->_valid  = $innerIterator->valid();

        if (false === $this->_valid) {
            return;
        }

        $this->_key     = $innerIterator->key();
        $this->_current = $innerIterator->current();

        return $innerIterator->next();
    }

    /**
     * Rewind the iterator to the first element.
     *
     * @return  void
     */
    public function rewind()
    {
        $out = $this->getInnerIterator()->rewind();
        $this->next();

        return $out;
    }

    /**
     * Check if current position is valid.
     *
     * @return  bool
     */
    public function valid()
    {
        return $this->_valid;
    }

    /**
     * Check whether there is a next element.
     *
     * @return  bool
     */
    public function hasNext()
    {
        return $this->getInnerIterator()->valid();
    }

    /**
     * Get next value.
     *
     * @return  mixed
     */
    public function getNext()
    {
        return $this->getInnerIterator()->current();
    }

    /**
     * Get next key.
     *
     * @return  mixed
     */
    public function getNextKey()
    {
        return $this->getInnerIterator()->key();
    }
}