HashTable::getByIndex() - Code Metrics - Inspection of "Support PHP 7.2" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c96e2d...d2f55f )

by Adrien

created 2018-01-28 07:24 UTC

HashTable::getByIndex() A

↳ Parent: HashTable

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	1
dl	0
loc	7
ccs	3
cts	4
cp	0.75
crap	2.0625
rs	9.4285
c	0
b	0
f	0

<?php

namespace PhpOffice\PhpSpreadsheet;

class HashTable
{
    /**
     * HashTable elements.
     *
     * @var IComparable[]
     */
    protected $items = [];

    /**
     * HashTable key map.
     *
     * @var string[]
     */
    protected $keyMap = [];

    /**
     * Create a new \PhpOffice\PhpSpreadsheet\HashTable.
     *
     * @param IComparable[] $pSource Optional source array to create HashTable from
     *
     * @throws Exception
     */
    public function __construct($pSource = null)
    {
        if ($pSource !== null) {
            // Create HashTable
            $this->addFromSource($pSource);
        }
    }

    /**
     * Add HashTable items from source.
     *
     * @param IComparable[] $pSource Source array to create HashTable from
     *
     * @throws Exception
     */
    public function addFromSource(array $pSource = null)
    {
        // Check if an array was passed
        if ($pSource == null) {
            return;
        }

        foreach ($pSource as $item) {
            $this->add($item);
        }
    }

    /**
     * Add HashTable item.
     *
     * @param IComparable $pSource Item to add
     */
    public function add(IComparable $pSource)
    {
        $hash = $pSource->getHashCode();
        if (!isset($this->items[$hash])) {
            $this->items[$hash] = $pSource;
            $this->keyMap[count($this->items) - 1] = $hash;
        }
    }

    /**
     * Remove HashTable item.
     *
     * @param IComparable $pSource Item to remove
     */
    public function remove(IComparable $pSource)
    {
        $hash = $pSource->getHashCode();
        if (isset($this->items[$hash])) {
            unset($this->items[$hash]);

            $deleteKey = -1;
            foreach ($this->keyMap as $key => $value) {
                if ($deleteKey >= 0) {
                    $this->keyMap[$key - 1] = $value;
                }

                if ($value == $hash) {
                    $deleteKey = $key;
                }
            }
            unset($this->keyMap[count($this->keyMap) - 1]);
        }
    }

    /**
     * Clear HashTable.
     */
    public function clear()
    {
        $this->items = [];
        $this->keyMap = [];
    }

    /**
     * Count.
     *
     * @return int
     */
    public function count()
    {
        return count($this->items);
    }

    /**
     * Get index for hash code.
     *
     * @param string $pHashCode
     *
     * @return int Index
     */
    public function getIndexForHashCode($pHashCode)
    {
        return array_search($pHashCode, $this->keyMap);

    }

    /**
     * Get by index.
     *
     * @param int $pIndex
     *
     * @return IComparable
     */
    public function getByIndex($pIndex)
    {
        if (isset($this->keyMap[$pIndex])) {
            return $this->getByHashCode($this->keyMap[$pIndex]);
        }

        return null;
    }

    /**
     * Get by hashcode.
     *
     * @param string $pHashCode
     *
     * @return IComparable
     */
    public function getByHashCode($pHashCode)
    {
        if (isset($this->items[$pHashCode])) {
            return $this->items[$pHashCode];
        }

        return null;
    }

    /**
     * HashTable to array.
     *
     * @return IComparable[]
     */
    public function toArray()
    {
        return $this->items;
    }

    /**
     * Implement PHP __clone to create a deep clone, not just a shallow copy.
     */
    public function __clone()
    {
        $vars = get_object_vars($this);
        foreach ($vars as $key => $value) {
            if (is_object($value)) {
                $this->$key = clone $value;
            }
        }
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet;
4
5		class HashTable
6		{
7		/**
8		* HashTable elements.
9		*
10		* @var IComparable[]
11		*/
12		protected $items = [];
13
14		/**
15		* HashTable key map.
16		*
17		* @var string[]
18		*/
19		protected $keyMap = [];
20
21		/**
22		* Create a new \PhpOffice\PhpSpreadsheet\HashTable.
23		*
24		* @param IComparable[] $pSource Optional source array to create HashTable from
25		*
26		* @throws Exception
27		*/
28	61	public function __construct($pSource = null)
29		{
30	61	if ($pSource !== null) {
31		// Create HashTable
32		$this->addFromSource($pSource);
33		}
34	61	}
35
36		/**
37		* Add HashTable items from source.
38		*
39		* @param IComparable[] $pSource Source array to create HashTable from
40		*
41		* @throws Exception
42		*/
43	60	public function addFromSource(array $pSource = null)
44		{
45		// Check if an array was passed
46	60	if ($pSource == null) {
47	60	return;
48		}
49
50	60	foreach ($pSource as $item) {
51	60	$this->add($item);
52		}
53	60	}
54
55		/**
56		* Add HashTable item.
57		*
58		* @param IComparable $pSource Item to add
59		*/
60	60	public function add(IComparable $pSource)
61		{
62	60	$hash = $pSource->getHashCode();
63	60	if (!isset($this->items[$hash])) {
64	60	$this->items[$hash] = $pSource;
65	60	$this->keyMap[count($this->items) - 1] = $hash;
66		}
67	60	}
68
69		/**
70		* Remove HashTable item.
71		*
72		* @param IComparable $pSource Item to remove
73		*/
74		public function remove(IComparable $pSource)
75		{
76		$hash = $pSource->getHashCode();
77		if (isset($this->items[$hash])) {
78		unset($this->items[$hash]);
79
80		$deleteKey = -1;
81		foreach ($this->keyMap as $key => $value) {
82		if ($deleteKey >= 0) {
83		$this->keyMap[$key - 1] = $value;
84		}
85
86		if ($value == $hash) {
87		$deleteKey = $key;
88		}
89		}
90		unset($this->keyMap[count($this->keyMap) - 1]);
91		}
92		}
93
94		/**
95		* Clear HashTable.
96		*/
97		public function clear()
98		{
99		$this->items = [];
100		$this->keyMap = [];
101		}
102
103		/**
104		* Count.
105		*
106		* @return int
107		*/
108	60	public function count()
109		{
110	60	return count($this->items);
111		}
112
113		/**
114		* Get index for hash code.
115		*
116		* @param string $pHashCode
117		*
118		* @return int Index
119		*/
120	60	public function getIndexForHashCode($pHashCode)
121		{
122	60	return array_search($pHashCode, $this->keyMap);
		0 ignored issues – show Bug Best Practice introduced 2017-12-03 09:09 UTC by Report Bug Copy Issue Report The expression `return array_search($pHashCode, $this->keyMap)` also could return the type `false\|string` which is incompatible with the documented return type `integer`. Loading history...
123		}
124
125		/**
126		* Get by index.
127		*
128		* @param int $pIndex
129		*
130		* @return IComparable
131		*/
132	60	public function getByIndex($pIndex)
133		{
134	60	if (isset($this->keyMap[$pIndex])) {
135	60	return $this->getByHashCode($this->keyMap[$pIndex]);
136		}
137
138		return null;
139		}
140
141		/**
142		* Get by hashcode.
143		*
144		* @param string $pHashCode
145		*
146		* @return IComparable
147		*/
148	60	public function getByHashCode($pHashCode)
149		{
150	60	if (isset($this->items[$pHashCode])) {
151	60	return $this->items[$pHashCode];
152		}
153
154		return null;
155		}
156
157		/**
158		* HashTable to array.
159		*
160		* @return IComparable[]
161		*/
162		public function toArray()
163		{
164		return $this->items;
165		}
166
167		/**
168		* Implement PHP __clone to create a deep clone, not just a shallow copy.
169		*/
170		public function __clone()
171		{
172		$vars = get_object_vars($this);
173		foreach ($vars as $key => $value) {
174		if (is_object($value)) {
175		$this->$key = clone $value;
176		}
177		}
178		}
179		}
180

PHPOffice / PhpSpreadsheet

Push — develop ( c96e2d...d2f55f )

HashTable::getByIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like