ClassConstantIterator::key() - Code Metrics - Inspection of "Feature/php parser2.0" - phpDocumentor/Reflection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#87)

by Jaap

created 2015-12-05 13:16 UTC

ClassConstantIterator::key() A

↳ Parent: ClassConstantIterator

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
dl	0
loc	4
c	1
b	0
f	1
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?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<[email protected]>
 * @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;

    }

    /**
     * Returns the fqsen of the current constant.
     *
     * @return Fqsen
     */
    public function getFqsen()
    {
        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.
     *
     * @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;
    }
}


1		<?php
2		/**
3		* This file is part of phpDocumentor.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*
8		* @copyright 2010-2015 Mike van Riel<[email protected]>
9		* @license http://www.opensource.org/licenses/mit-license.php MIT
10		* @link http://phpdoc.org
11		*/
12
13
14		namespace phpDocumentor\Reflection\Php\Factory;
15
16		use phpDocumentor\Reflection\Fqsen;
17		use PhpParser\Comment\Doc;
18		use PhpParser\Node\Stmt\ClassConst;
19
20		/**
21		* This class acts like a combination of a ClassConst and Const_ to be able to create constant descriptors using a normal strategy.
22		*/
23		final class ClassConstantIterator implements \Iterator
24		{
25		/**
26		* @var ClassConst
27		*/
28		private $classConstants;
29
30		/** @var int index of the current ClassConst to use */
31		private $index = 0;
32
33		/**
34		* Initializes the class with source data.
35		*
36		* @param ClassConst $classConst
37		*/
38	1	public function __construct(ClassConst $classConst)
39		{
40	1	$this->classConstants = $classConst;
41	1	}
42
43		/**
44		* Gets line the node started in.
45		*
46		* @return int Line
47		*/
48	1	public function getLine()
49		{
50	1	return $this->classConstants->getLine();
51		}
52
53		/**
54		* Returns the name of the current constant.
55		*
56		* @return string
57		*/
58	1	public function getName()
59		{
60	1	return $this->classConstants->consts[$this->index]->name;
		0 ignored issues – show Coding Style introduced 2015-11-23 21:15 UTC by Report Bug Copy Issue Report It seems like the identation of this line is off (expected at least 8 spaces, but found 7). Loading history...
61		}
62
63		/**
64		* Returns the fqsen of the current constant.
65		*
66		* @return Fqsen
67		*/
68	1	public function getFqsen()
69		{
70	1	return $this->classConstants->consts[$this->index]->fqsen;
		0 ignored issues – show Bug introduced 2015-11-23 21:15 UTC by Report Bug Copy Issue Report The property `fqsen` does not seem to exist in `PhpParser\Node\Const_`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
71		}
72
73		/**
74		* Gets the doc comment of the node.
75		*
76		* The doc comment has to be the last comment associated with the node.
77		*
78		* @return null\|Doc Doc comment object or null
79		*/
80	2	public function getDocComment()
81		{
82	2	$docComment = $this->classConstants->consts[$this->index]->getDocComment();
83	2	if ($docComment === null) {
84	1	$docComment = $this->classConstants->getDocComment();
85		}
86
87	2	return $docComment;
88		}
89
90		public function getValue()
91		{
92		return $this->classConstants->consts[$this->index]->value;
93		}
94
95		/**
96		* (PHP 5 >= 5.0.0)<br/>
97		* Return the current element
98		* @link http://php.net/manual/en/iterator.current.php
99		* @return mixed Can return any type.
100		*/
101	1	public function current()
102		{
103	1	return $this;
104		}
105
106		/**
107		* (PHP 5 >= 5.0.0)<br/>
108		* Move forward to next element
109		* @link http://php.net/manual/en/iterator.next.php
110		* @return void Any returned value is ignored.
111		*/
112	2	public function next()
113		{
114	2	$this->index++;
115	2	}
116
117		/**
118		* (PHP 5 >= 5.0.0)<br/>
119		* Return the key of the current element
120		* @link http://php.net/manual/en/iterator.key.php
121		* @return mixed scalar on success, or null on failure.
122		*/
123	1	public function key()
124		{
125	1	return $this->index;
126		}
127
128		/**
129		* (PHP 5 >= 5.0.0)<br/>
130		* Checks if current position is valid
131		* @link http://php.net/manual/en/iterator.valid.php
132		* @return boolean The return value will be casted to boolean and then evaluated.
133		* Returns true on success or false on failure.
134		*/
135	1	public function valid()
136		{
137	1	return isset($this->classConstants->consts[$this->index]);
138		}
139
140		/**
141		* (PHP 5 >= 5.0.0)<br/>
142		* Rewind the Iterator to the first element
143		* @link http://php.net/manual/en/iterator.rewind.php
144		* @return void Any returned value is ignored.
145		*/
146	1	public function rewind()
147		{
148	1	$this->index = 0;
149	1	}
150		}
151

phpDocumentor / Reflection

Pull Request — develop (#87)

ClassConstantIterator::key() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like