ChainTrait::chain() - Code Metrics - Inspection of "Merge pull request #19 from zicht/feature/code-cov..." - zicht/itertools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( faf39f...21841e )

by Gerard van

created 2017-02-07 10:51 UTC

ChainTrait::chain() A

↳ Parent: ChainTrait

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	0

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

<?php
/**
 * @author Boudewijn Schoon <[email protected]>
 * @copyright Zicht Online <http://zicht.nl>
 */

namespace Zicht\Itertools\lib\Traits;

use Zicht\Itertools as iter;

trait ChainTrait
{
    /**
     * Returns an iterator that returns elements from the first iterable
     * until it is exhausted, then proceeds to the next iterable, until
     * all the iterables are exhausted.
     *
     * Used for creating consecutive sequences as a single sequence.
     *
     * Note that the keys of the returned ChainIterator follow 0, 1, etc,
     * regardless of the keys given in the iterables.
     *
     * > iter\iterable([1, 2, 3], [4, 5, 6])->chain()
     * 1 2 3 4 5 6
     *
     * > iter\iterable('ABC', 'DEF')->chain()
     * A B C D E F
     *
     * @param array|string|\Iterator $iterable
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param array|string|\Iterator $iterable2
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return iter\lib\ChainIterator
     */
    public function chain(/* $iterable, $iterable2, ... */)

    {
        return call_user_func_array('\Zicht\itertools\chain', array_merge([$this], func_get_args()));
    }
}


1		<?php
2		/**
3		* @author Boudewijn Schoon <[email protected]>
4		* @copyright Zicht Online <http://zicht.nl>
5		*/
6
7		namespace Zicht\Itertools\lib\Traits;
8
9		use Zicht\Itertools as iter;
10
11		trait ChainTrait
12		{
13		/**
14		* Returns an iterator that returns elements from the first iterable
15		* until it is exhausted, then proceeds to the next iterable, until
16		* all the iterables are exhausted.
17		*
18		* Used for creating consecutive sequences as a single sequence.
19		*
20		* Note that the keys of the returned ChainIterator follow 0, 1, etc,
21		* regardless of the keys given in the iterables.
22		*
23		* > iter\iterable([1, 2, 3], [4, 5, 6])->chain()
24		* 1 2 3 4 5 6
25		*
26		* > iter\iterable('ABC', 'DEF')->chain()
27		* A B C D E F
28		*
29		* @param array\|string\|\Iterator $iterable
		0 ignored issues – show Bug introduced 2017-01-12 12:49 UTC by Report Bug Copy Issue Report There is no parameter named `$iterable`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
30		* @param array\|string\|\Iterator $iterable2
		0 ignored issues – show Bug introduced 2017-01-12 12:49 UTC by Report Bug Copy Issue Report There is no parameter named `$iterable2`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
31		* @return iter\lib\ChainIterator
32		*/
33	2	public function chain(/* $iterable, $iterable2, ... */)
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-12 12:49 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
34		{
35	2	return call_user_func_array('\Zicht\itertools\chain', array_merge([$this], func_get_args()));
36		}
37		}
38

zicht / itertools

Push — master ( faf39f...21841e )

ChainTrait::chain() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like