RowByRowResult::key() - Code Metrics - Inspection of "Introduce `getIterable()` on AbstractQuery" - doctrine/orm - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#7885)

by Šimon

created 2019-12-01 12:37 UTC

RowByRowResult::key() A

↳ Parent: RowByRowResult

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
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Doctrine\ORM\Internal\Hydration;

use Iterator;
use function array_values;
use function is_array;

/**
 * Represents a result structure that can be iterated over, hydrating row-by-row
 * during the iteration. An IterableResult is obtained by AbstractHydrator#getIterable().
 */
final class RowByRowResult implements Iterator
{
    /** @var AbstractHydrator */
    private $hydrator;

    /** @var bool */
    private $rewinded = false;

    /** @var int */
    private $key = -1;

    /** @var object|null */
    private $current;

    public function __construct(AbstractHydrator $hydrator)
    {
        $this->hydrator = $hydrator;
    }

    /**
     * @throws HydrationException
     */
    public function rewind() : void
    {
        if ($this->rewinded === true) {
            throw new HydrationException('Can only iterate a Result once.');
        }

        $this->current  = $this->next();

        $this->rewinded = true;
    }

    /**
     * Gets the next set of results.
     *
     * @return mixed|false
     */
    public function next()
    {
        $this->current = $this->hydrator->hydrateRow();

        if (is_array($this->current)) {

            $this->current = array_values($this->current)[0];
        }

        $this->key++;

        return $this->current;
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.
    }
}
    }

    /** @return mixed */
    public function current()
    {
        return $this->current;
    }

    public function key() : int
    {
        return $this->key;
    }

    public function valid() : bool
    {
        return $this->current !== false;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\ORM\Internal\Hydration;
6
7		use Iterator;
8		use function array_values;
9		use function is_array;
10
11		/**
12		* Represents a result structure that can be iterated over, hydrating row-by-row
13		* during the iteration. An IterableResult is obtained by AbstractHydrator#getIterable().
14		*/
15		final class RowByRowResult implements Iterator
16		{
17		/** @var AbstractHydrator */
18		private $hydrator;
19
20		/** @var bool */
21		private $rewinded = false;
22
23		/** @var int */
24		private $key = -1;
25
26		/** @var object\|null */
27		private $current;
28
29	23	public function __construct(AbstractHydrator $hydrator)
30		{
31	23	$this->hydrator = $hydrator;
32	23	}
33
34		/**
35		* @throws HydrationException
36		*/
37	22	public function rewind() : void
38		{
39	22	if ($this->rewinded === true) {
40		throw new HydrationException('Can only iterate a Result once.');
41		}
42
43	22	$this->current = $this->next();
		0 ignored issues – show Documentation Bug introduced 2019-11-02 13:36 UTC by Report Bug Copy Issue Report It seems like `$this->next()` of type `false` is incompatible with the declared type `null\|object` of property `$current`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
44	22	$this->rewinded = true;
45	22	}
46
47		/**
48		* Gets the next set of results.
49		*
50		* @return mixed\|false
51		*/
52	22	public function next()
53		{
54	22	$this->current = $this->hydrator->hydrateRow();
		0 ignored issues – show Documentation Bug introduced 2019-11-02 13:36 UTC by Report Bug Copy Issue Report It seems like `$this->hydrator->hydrateRow()` of type `false` is incompatible with the declared type `null\|object` of property `$current`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
55	22	if (is_array($this->current)) {
		0 ignored issues – show introduced 2019-11-02 23:19 UTC by Report Bug Copy Issue Report The condition `is_array($this->current)` is always `false`. Loading history...
56	21	$this->current = array_values($this->current)[0];
57		}
58
59	22	$this->key++;
60
61	22	return $this->current;
		0 ignored issues – show Bug Best Practice introduced 2019-11-02 13:36 UTC by Report Bug Copy Issue Report The expression `return $this->current` returns the type `false` which is incompatible with the return type mandated by `Iterator::next()` of `void`. 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...
62		}
63
64		/** @return mixed */
65	21	public function current()
66		{
67	21	return $this->current;
68		}
69
70	16	public function key() : int
71		{
72	16	return $this->key;
73		}
74
75	22	public function valid() : bool
76		{
77	22	return $this->current !== false;
78		}
79		}
80

doctrine / orm

Pull Request — master (#7885)

RowByRowResult::key() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like