Completed
Push — master ( 9610e0...320eee )
by Doug
08:43
created

ItemList::asArray()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 8
ccs 5
cts 5
cp 1
rs 9.4285
c 0
b 0
f 0
cc 2
eloc 5
nc 2
nop 0
crap 2
1
<?php
2
/**
3
 * Box packing (3D bin packing, knapsack problem)
4
 * @package BoxPacker
5
 * @author Doug Wright
6
 */
7
namespace DVDoug\BoxPacker;
8
9
/**
10
 * List of items to be packed, ordered by volume
11
 * @author Doug Wright
12
 * @package BoxPacker
13
 */
14
class ItemList extends \SplMaxHeap
15
{
16
17
    /**
18
     * Compare elements in order to place them correctly in the heap while sifting up.
19
     *
20
     * @see \SplMaxHeap::compare()
21
     *
22
     * @param mixed $itemA
23
     * @param mixed $itemB
24
     *
25
     * @return int
0 ignored issues
show
Documentation introduced by
Should the return type not be integer|double?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
26
     */
27 34
    public function compare($itemA, $itemB)
28
    {
29 34
        if ($itemA->getVolume() > $itemB->getVolume()) {
30 14
            return 1;
31 34
        } elseif ($itemA->getVolume() < $itemB->getVolume()) {
32 14
            return -1;
33
        } else {
34 31
            return $itemA->getWeight() - $itemB->getWeight();
35
        }
36
    }
37
38
    /**
39
     * Get copy of this list as a standard PHP array
40
     * @return array
41
     */
42 25
    public function asArray()
43
    {
44 25
        $return = [];
45 25
        foreach (clone $this as $item) {
46 25
            $return[] = $item;
47
        }
48 25
        return $return;
49
    }
50
}
51