phpDocumentor\Reflection\Php\Factory\ClassConstantIterator

Complexity

Total Complexity

12

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

92.86%

Importance

Changes	3
Bugs	1	Features	1

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	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
A	getDocComment()	0	9	2

<?php
/**
 * 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-2015 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 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.
     *
     * @param ClassConst $classConst
     */
    public function __construct(ClassConst $classConst)
    {
        $this->classConstants = $classConst;
    }

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

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

It seems like the identation of this line is off (expected at least 8 spaces, but found 7).

    }

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

The property fqsen does not seem to exist in PhpParser\Node\Const_.

    }

    /**
     * Gets the doc comment of the node.
     *
     * The doc comment has to be the last comment associated with the node.
     *
     * @return null|Doc Doc comment object or null
     */
    public function getDocComment()
    {
        $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;
    }

    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Return the current element
     * @link http://php.net/manual/en/iterator.current.php
     * @return mixed Can return any type.
     */
    public function current()
    {
        return $this;
    }

    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Move forward to next element
     * @link http://php.net/manual/en/iterator.next.php
     * @return void Any returned value is ignored.
     */
    public function next()
    {
        $this->index++;
    }

    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Return the key of the current element
     * @link http://php.net/manual/en/iterator.key.php
     * @return mixed scalar on success, or null on failure.
     */
    public function key()
    {
        return $this->index;
    }

    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Checks if current position is valid
     * @link http://php.net/manual/en/iterator.valid.php
     * @return boolean The return value will be casted to boolean and then evaluated.
     * Returns true on success or false on failure.
     */
    public function valid()
    {
        return isset($this->classConstants->consts[$this->index]);
    }

    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Rewind the Iterator to the first element
     * @link http://php.net/manual/en/iterator.rewind.php
     * @return void Any returned value is ignored.
     */
    public function rewind()
    {
        $this->index = 0;
    }
}