IntRange::getValueByIndex() - Code Metrics - Inspection of "Method `SequenceInterface::getStartValue()` added." - Smoren/sequence-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ae6524...8dfa4a )

by Smoren

created 2022-12-29 08:49 UTC

IntRange::getValueByIndex() A

↳ Parent: IntRange

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Smoren\Sequence\Structs;

use Smoren\Sequence\Traits\SequenceTrait;

/**
 * {@inheritDoc}
 */
class IntRange extends IntSequence
{
    use SequenceTrait;

    /**
     * @param int $index
     * @return int
     */
    public function getValueByIndex(int $index): int
    {
        return $this->start + $index * $this->step;
    }

    /**
     * @return int
     */
    public function getStartValue(): int
    {
        return $this->getValueByIndex(0);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Smoren\Sequence\Structs;
6
7		use Smoren\Sequence\Traits\SequenceTrait;
8
9		/**
10		* {@inheritDoc}
11		*/
12		class IntRange extends IntSequence
13		{
14		use SequenceTrait;
15
16		/**
17		* @param int $index
18		* @return int
19		*/
20	7	public function getValueByIndex(int $index): int
21		{
22	7	return $this->start + $index * $this->step;
23		}
24
25		/**
26		* @return int
27		*/
28		public function getStartValue(): int
29		{
30		return $this->getValueByIndex(0);
		0 ignored issues – show Bug Best Practice introduced 2022-12-29 08:51 UTC by Report Bug Copy Issue Report The expression `return $this->getValueByIndex(0)` returns the type `integer` which is incompatible with the return type mandated by `Smoren\Sequence\Interfac...erface::getStartValue()` of `Smoren\Sequence\Interfaces\T`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
31		}
32		}
33

Smoren / sequence-php

Push — master ( ae6524...8dfa4a )

IntRange::getValueByIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like