TQ\Vcs\Buffer\ArrayBuffer

Complexity

Total Complexity

6

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	current()	0	4	1
A	next()	0	4	1
A	key()	0	4	1
A	valid()	0	4	1
A	rewind()	0	4	1

<?php
/*
 * Copyright (C) 2017 by TEQneers GmbH & Co. KG
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/**
 * Git Stream Wrapper for PHP
 *
 * @category   TQ
 * @package    TQ_VCS
 * @subpackage VCS
 * @copyright  Copyright (C) 2018 by TEQneers GmbH & Co. KG
 */

namespace TQ\Vcs\Buffer;

/**
 * Simple class to iterate over an array
 *
 * @author     Stefan Gehrig <gehrigteqneers.de>
 * @category   TQ
 * @package    TQ_VCS
 * @subpackage VCS
 * @copyright  Copyright (C) 2018 by TEQneers GmbH & Co. KG
 */
class ArrayBuffer implements \Iterator
{
    /**
     * The array
     *
     * @var array
     */
    protected $array;

    /**
     * Creates an array buffer from an array
     *
     * @param   array   $array    The array
     */
    public function __construct(array $array)
    {
        $this->array  = $array;
        reset($this->array);
    }

    /**
     * Implements Iterator
     *
     * @link    http://php.net/manual/en/iterator.current.php
     * @return  string
     */
    public function current()
    {
        return current($this->array);
    }

    /**
     * Implements Iterator
     *
     * @link    http://php.net/manual/en/iterator.next.php
     */
    public function next()
    {
        next($this->array);
    }

    /**
     * Implements Iterator
     *
     * @link    http://php.net/manual/en/iterator.key.php
     * @return  integer|boolean     False on failure
     */
    public function key()
    {
        return key($this->array);
    }

    /**
     * Implements Iterator
     *
     * @link    http://php.net/manual/en/iterator.valid.php
     * @return  boolean
     */
    public function valid()
    {
        return (key($this->array) !== null);
    }

    /**
     * Implements Iterator
     *
     * @link    http://php.net/manual/en/iterator.rewind.php
     */
    public function rewind()
    {
        reset($this->array);
    }
}