phpDocumentor\Reflection\Php\Factory\ClassConstantIterator

Complexity

Total Complexity

12

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

92.86%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getLine()	0	4	1
A	getName()	0	4	1
A	getFqsen()	0	4	1
A	getDocComment()	0	9	2
A	getValue()	0	4	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
declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @copyright 2010-2018 Mike van Riel<mike@phpdoc.org>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Reflection\Php\Factory;

use Iterator;
use phpDocumentor\Reflection\Fqsen;
use PhpParser\Comment\Doc;
use PhpParser\Node\Stmt\ClassConst;

/**
 * This class acts like a combination of a ClassConst and Const_
 * to be able to create constant descriptors using a normal strategy.
 */
final class ClassConstantIterator implements Iterator
{
    /**
     * @var ClassConst
     */
    private $classConstants;

    /**
     * @var int index of the current ClassConst to use
     */
    private $index = 0;

    /**
     * Initializes the class with source data.
     */
    public function __construct(ClassConst $classConst)
    {
        $this->classConstants = $classConst;
    }

    /**
     * Gets line the node started in.
     *
     * @return int Line
     */
    public function getLine(): int
    {
        return $this->classConstants->getLine();
    }

    /**
     * Returns the name of the current constant.
     */
    public function getName(): string
    {
        return (string) $this->classConstants->consts[$this->index]->name;
    }

    /**
     * Returns the fqsen of the current constant.
     */
    public function getFqsen(): Fqsen
    {
        return $this->classConstants->consts[$this->index]->fqsen;
    }

    /**
     * Gets the doc comment of the node.
     *
     * The doc comment has to be the last comment associated with the node.
     */
    public function getDocComment(): ?Doc
    {
        $docComment = $this->classConstants->consts[$this->index]->getDocComment();
        if ($docComment === null) {
            $docComment = $this->classConstants->getDocComment();
        }

        return $docComment;
    }

    public function getValue()
    {
        return $this->classConstants->consts[$this->index]->value;
    }

    /**
     * @link http://php.net/manual/en/iterator.current.php
     */
    public function current(): self
    {
        return $this;
    }

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

    /**
     * @link http://php.net/manual/en/iterator.key.php
     */
    public function key(): ?int
    {
        return $this->index;
    }

    /**
     * @link http://php.net/manual/en/iterator.valid.php
     */
    public function valid(): bool
    {
        return isset($this->classConstants->consts[$this->index]);
    }

    /**
     * @link http://php.net/manual/en/iterator.rewind.php
     */
    public function rewind(): void
    {
        $this->index = 0;
    }
}