Completed
Push — master ( 380bc9...d6f30d )
by Jesse
02:30
created

Sorter::function()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 1
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
declare(strict_types=1);
3
4
namespace Stratadox\Sorting;
5
6
use Closure;
7
use Stratadox\Sorting\Contracts\DefinesHowToSort;
8
use Stratadox\Sorting\Contracts\SortsTheElements;
9
10
/**
11
 * Sorter logic for comparing multiple values according to the sort definition.
12
 *
13
 * Leaves retrieving the values to the concrete implementations.
14
 *
15
 * @author  Stratadox
16
 * @package Stratadox\Sorting
17
 */
18
abstract class Sorter implements SortsTheElements
19
{
20
    public function sortThe($elements, DefinesHowToSort $sorting): array
21
    {
22
        usort($elements, $this->functionFor($sorting));
23
        return $elements;
24
    }
25
26
    private function functionFor(DefinesHowToSort $sorting): Closure
27
    {
28
        return function ($element1, $element2) use ($sorting) {
29
            return $this->doTheSorting($element1, $element2, $sorting);
30
        };
31
    }
32
33
    private function doTheSorting(
34
        $element1,
35
        $element2,
36
        DefinesHowToSort $sorting
37
    ): int {
38
        $comparison = 0;
39
        while ($sorting->isRequired()) {
40
            $comparison = $this->compareElements(
41
                $element1,
42
                $element2,
43
                $sorting
44
            );
45
            if ($comparison !== 0) {
46
                break;
47
            }
48
            $sorting = $sorting->next();
49
        }
50
        return $comparison;
51
    }
52
53
    private function compareElements(
54
        $element1,
55
        $element2,
56
        DefinesHowToSort $sorting
57
    ): int {
58
        if ($sorting->ascends()) {
59
            return $this->compareValues(
60
                $this->valueFor($element1, $sorting->field()),
61
                $this->valueFor($element2, $sorting->field())
62
            );
63
        }
64
        return $this->compareValues(
65
            $this->valueFor($element2, $sorting->field()),
66
            $this->valueFor($element1, $sorting->field())
67
        );
68
    }
69
70
    private function compareValues($value1, $value2): int
71
    {
72
        return $value1 <=> $value2;
73
    }
74
75
    abstract protected function valueFor($element, string $field);
76
}
77