AbstractArrayDriver::maybeRemoveItem() - Code Metrics - Inspection of "complete support for using a map with user-defined..." - spider-mane/collection - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a4571b...162929 )

by Chris

created 2022-04-23 08:42 UTC

AbstractArrayDriver::maybeRemoveItem() A

↳ Parent: AbstractArrayDriver

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

namespace WebTheory\Collection\Driver\Abstracts;

use WebTheory\Collection\Contracts\ArrayDriverInterface;
use WebTheory\Collection\Contracts\ObjectComparatorInterface;

abstract class AbstractArrayDriver implements ArrayDriverInterface
{
    protected ObjectComparatorInterface $objectComparator;

    public function __construct(ObjectComparatorInterface $objectComparator)
    {
        $this->objectComparator = $objectComparator;
    }

    public function insert(array &$array, object $item, $offset = null): bool
    {
        if ($this->arrayContainsObject($array, $item)) {
            return false;
        }

        $this->insertItem($array, $item, $offset);

        return true;
    }

    public function fetch(array $array, $item)
    {
        return $array[$item];
    }

    public function remove(array &$array, $item): bool
    {
        return is_object($item)
            ? $this->deleteObjectIfLocated($array, $item)
            : $this->maybeRemoveItem($array, $item);
    }

    public function contains(array $array, $item): bool
    {
        return is_object($item)
            ? $this->arrayContainsObject($array, $item)
            : $this->arrayContains($array, $item);
    }

    protected function maybeRemoveItem(array &$array, $item): bool
    {
        if (isset($array[$item])) {
            unset($array[$item]);

            return true;
        }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }

    protected function arrayContains(array $array, $item): bool
    {
        return isset($array[$item]);
    }

    protected function arrayContainsObject(array $array, object $object): bool
    {
        foreach ($array as $item) {
            if ($this->objectComparator->matches($item, $object)) {
                return true;
            }
        }

        return false;
    }

    protected function deleteObjectIfLocated(array &$array, object $object): bool
    {
        $position = array_search($object, $array, true);

        if ($position === false) {
            return false;
        }

        unset($array[$position]);

        return true;
    }

    abstract protected function insertItem(array &$array, object $item, $offset = null): void;
}


1		<?php
2
3		namespace WebTheory\Collection\Driver\Abstracts;
4
5		use WebTheory\Collection\Contracts\ArrayDriverInterface;
6		use WebTheory\Collection\Contracts\ObjectComparatorInterface;
7
8		abstract class AbstractArrayDriver implements ArrayDriverInterface
9		{
10		protected ObjectComparatorInterface $objectComparator;
11
12	129	public function __construct(ObjectComparatorInterface $objectComparator)
13		{
14	129	$this->objectComparator = $objectComparator;
15		}
16
17	306	public function insert(array &$array, object $item, $offset = null): bool
18		{
19	306	if ($this->arrayContainsObject($array, $item)) {
20	9	return false;
21		}
22
23	306	$this->insertItem($array, $item, $offset);
24
25	306	return true;
26		}
27
28		public function fetch(array $array, $item)
29		{
30		return $array[$item];
31		}
32
33	9	public function remove(array &$array, $item): bool
34		{
35	9	return is_object($item)
36	6	? $this->deleteObjectIfLocated($array, $item)
37	9	: $this->maybeRemoveItem($array, $item);
38		}
39
40	24	public function contains(array $array, $item): bool
41		{
42	24	return is_object($item)
43	6	? $this->arrayContainsObject($array, $item)
44	24	: $this->arrayContains($array, $item);
45		}
46
47	3	protected function maybeRemoveItem(array &$array, $item): bool
48		{
49	3	if (isset($array[$item])) {
50	3	unset($array[$item]);
51
52	3	return true;
53		}
		0 ignored issues – show Bug Best Practice introduced 2022-04-23 08:49 UTC by Report Bug Copy Issue Report The function implicitly returns `null` when the `if` condition on line 49 is `false`. This is incompatible with the type-hinted return `boolean`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
54		}
55
56	12	protected function arrayContains(array $array, $item): bool
57		{
58	12	return isset($array[$item]);
59		}
60
61	306	protected function arrayContainsObject(array $array, object $object): bool
62		{
63	306	foreach ($array as $item) {
64	306	if ($this->objectComparator->matches($item, $object)) {
65	12	return true;
66		}
67		}
68
69	306	return false;
70		}
71
72	6	protected function deleteObjectIfLocated(array &$array, object $object): bool
73		{
74	6	$position = array_search($object, $array, true);
75
76	6	if ($position === false) {
77		return false;
78		}
79
80	6	unset($array[$position]);
81
82	6	return true;
83		}
84
85		abstract protected function insertItem(array &$array, object $item, $offset = null): void;
86		}
87

spider-mane / collection

Push — master ( a4571b...162929 )

AbstractArrayDriver::maybeRemoveItem() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like