Passed
Pull Request — master (#4240)
by Owen
13:17
created

DataValidator::isValueInList()   B

Complexity

Conditions 8
Paths 14

Size

Total Lines 29
Code Lines 16

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 1
CRAP Score 8

Importance

Changes 0
Metric Value
eloc 16
c 0
b 0
f 0
dl 0
loc 29
ccs 1
cts 1
cp 1
rs 8.4444
cc 8
nc 14
nop 1
crap 8
1
<?php
2
3
namespace PhpOffice\PhpSpreadsheet\Cell;
4
5
use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
6
use PhpOffice\PhpSpreadsheet\Calculation\Functions;
7
use PhpOffice\PhpSpreadsheet\Exception;
8
9
/**
10
 * Validate a cell value according to its validation rules.
11
 */
12
class DataValidator
13
{
14
    /**
15
     * Does this cell contain valid value?
16
     *
17
     * @param Cell $cell Cell to check the value
18
     */
19 8
    public function isValid(Cell $cell): bool
20
    {
21 8
        if (!$cell->hasDataValidation() || $cell->getDataValidation()->getType() === DataValidation::TYPE_NONE) {
22 2
            return true;
23
        }
24
25 7
        $cellValue = $cell->getValue();
26 7
        $dataValidation = $cell->getDataValidation();
27
28 7
        if (!$dataValidation->getAllowBlank() && ($cellValue === null || $cellValue === '')) {
29 1
            return false;
30
        }
31
32 7
        $returnValue = false;
33 7
        $type = $dataValidation->getType();
34 7
        if ($type === DataValidation::TYPE_LIST) {
35 5
            $returnValue = $this->isValueInList($cell);
36 5
        } elseif ($type === DataValidation::TYPE_WHOLE) {
37 4
            if (!is_numeric($cellValue) || fmod((float) $cellValue, 1) != 0) {
38 3
                $returnValue = false;
39
            } else {
40 4
                $returnValue = $this->numericOperator($dataValidation, (int) $cellValue, $cell);
41
            }
42 4
        } elseif ($type === DataValidation::TYPE_DECIMAL || $type === DataValidation::TYPE_DATE || $type === DataValidation::TYPE_TIME) {
43 3
            if (!is_numeric($cellValue)) {
44 3
                $returnValue = false;
45
            } else {
46 3
                $returnValue = $this->numericOperator($dataValidation, (float) $cellValue, $cell);
47
            }
48 4
        } elseif ($type === DataValidation::TYPE_TEXTLENGTH) {
49 3
            $returnValue = $this->numericOperator($dataValidation, mb_strlen($cell->getValueString()), $cell);
50
        }
51
52 7
        return $returnValue;
53
    }
54
55 4
    private const TWO_FORMULAS = [DataValidation::OPERATOR_BETWEEN, DataValidation::OPERATOR_NOTBETWEEN];
56
57 4
    private static function evaluateNumericFormula(mixed $formula, Cell $cell): mixed
58 4
    {
59 4
        if (!is_numeric($formula)) {
60 4
            $calculation = Calculation::getInstance($cell->getWorksheet()->getParent());
61 4
62 4
            try {
63 3
                $result = $calculation
64 3
                    ->calculateFormula("=$formula", $cell->getCoordinate(), $cell);
65 3
                while (is_array($result)) {
66 3
                    $result = array_pop($result);
67 3
                }
68 3
                $formula = $result;
69 3
            } catch (Exception) {
70 3
                // do nothing
71 3
            }
72 3
        }
73 3
74 3
        return $formula;
75 3
    }
76 3
77
    private function numericOperator(DataValidation $dataValidation, int|float $cellValue, Cell $cell): bool
78
    {
79 4
        $operator = $dataValidation->getOperator();
80
        $formula1 = self::evaluateNumericFormula(
81
            $dataValidation->getFormula1(),
82
            $cell
83
        );
84
85
        $formula2 = 0;
86
        if (in_array($operator, self::TWO_FORMULAS, true)) {
87 5
            $formula2 = self::evaluateNumericFormula(
88
                $dataValidation->getFormula2(),
89 5
                $cell
90 5
            );
91
        }
92 5
93 5
        return match ($operator) {
94
            DataValidation::OPERATOR_BETWEEN => $cellValue >= $formula1 && $cellValue <= $formula2,
95 5
            DataValidation::OPERATOR_NOTBETWEEN => $cellValue < $formula1 || $cellValue > $formula2,
96 4
            DataValidation::OPERATOR_EQUAL => $cellValue == $formula1,
97 5
            DataValidation::OPERATOR_NOTEQUAL => $cellValue != $formula1,
98
            DataValidation::OPERATOR_LESSTHAN => $cellValue < $formula1,
99 5
            DataValidation::OPERATOR_LESSTHANOREQUAL => $cellValue <= $formula1,
100 5
            DataValidation::OPERATOR_GREATERTHAN => $cellValue > $formula1,
101
            DataValidation::OPERATOR_GREATERTHANOREQUAL => $cellValue >= $formula1,
102
            default => false,
103 5
        };
104 5
    }
105 5
106
    /**
107
     * Does this cell contain valid value, based on list?
108 5
     *
109 1
     * @param Cell $cell Cell to check the value
110 1
     */
111
    private function isValueInList(Cell $cell): bool
112
    {
113
        $cellValueString = $cell->getValueString();
114
        $dataValidation = $cell->getDataValidation();
115 1
116
        $formula1 = $dataValidation->getFormula1();
117
        if (!empty($formula1)) {
118
            // inline values list
119
            if ($formula1[0] === '"') {
120
                return in_array(strtolower($cellValueString), explode(',', strtolower(trim($formula1, '"'))), true);
121
            }
122
            $calculation = Calculation::getInstance($cell->getWorksheet()->getParent());
123
124
            try {
125
                $result = $calculation->calculateFormula("=$formula1", $cell->getCoordinate(), $cell);
126
                $result = is_array($result) ? Functions::flattenArray($result) : [$result];
127
                foreach ($result as $oneResult) {
128
                    if (is_scalar($oneResult) && strcasecmp((string) $oneResult, $cellValueString) === 0) {
129
                        return true;
130
                    }
131
                }
132
            } catch (Exception) {
133
                // do nothing
134
            }
135
136
            return false;
137
        }
138
139
        return true;
140
    }
141
}
142