Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00%
25 / 25
100.00%
2 / 2
 CRAP
100.00%
1 / 1
HasOneThatEquals
100.00%
25 / 25
100.00%
2 / 2
 16
100.00%
1 / 1
 evaluate
100.00%
16 / 16
100.00%
1 / 1
 10
 generateDefaultMessage
100.00%
9 / 9
100.00%
1 / 1
 6
1<?php
2/**
3 * Pop PHP Framework (http://www.popphp.org/)
4 *
5 * @link       https://github.com/popphp/popphp-framework
6 * @author     Nick Sagona, III <dev@noladev.com>
7 * @copyright  Copyright (c) 2009-2025 NOLA Interactive, LLC.
8 * @license    http://www.popphp.org/license     New BSD License
9 */
10
11/**
12 * @namespace
13 */
14namespace Pop\Validator;
15
16/**
17 * Has one that equals validator class
18 *
19 * @category   Pop
20 * @package    Pop\Validator
21 * @author     Nick Sagona, III <dev@noladev.com>
22 * @copyright  Copyright (c) 2009-2025 NOLA Interactive, LLC.
23 * @license    http://www.popphp.org/license     New BSD License
24 * @version    4.5.0
25 */
26class HasOneThatEquals extends AbstractValidator
27{
28
29    /**
30     * Traits
31     */
32    use TraverseTrait;
33
34    /**
35     * Method to evaluate the validator
36     *
37     * @param  mixed $input
38     * @throws Exception
39     * @return bool
40     */
41    public function evaluate(mixed $input = null): bool
42    {
43        // Set the input, if passed
44        if ($input !== null) {
45            $this->input = $input;
46        }
47
48        if (!is_array($input)) {
49            throw new Exception('Error: The evaluated input must be an array.');
50        }
51        if (!is_array($this->value)) {
52            throw new Exception("Error: The evaluated value must be an array of node name and value, e.g. ['node' => 3].");
53        }
54
55        $field         = array_key_first($this->value);
56        $requiredValue = reset($this->value);
57
58        // Set the default message
59        if (!$this->hasMessage()) {
60            $this->generateDefaultMessage();
61        }
62
63        if (!str_contains($field, '.')) {
64            return (array_key_exists($field, $this->input) &&
65                !is_array($this->input[$field]) && ($this->input[$field] == $requiredValue));
66        } else {
67            $value = [];
68            self::traverseData($field, $this->input, $value);
69            return ((is_array($value) && in_array($requiredValue, $value)) || ($value == $requiredValue));
70        }
71    }
72
73    /**
74     * Generate default message
75
76     * @param  mixed $name
77     * @param  mixed $value
78     * @return string
79     */
80    public function generateDefaultMessage(mixed $name = null, mixed $value = null): string
81    {
82        $field = null;
83
84        if (($value !== null) && is_array($value)) {
85            $field = array_key_first($value);
86        } else if ($this->value !== null) {
87            $field = array_key_first($this->value);
88        }
89
90        $this->message = "The " . (($name !== null) ? "'" . $name . "'" : "value") .
91            " must contain one item" . (($this->value !== null) ? " of '" . $field . "'" : "") .
92            " with the required value.";
93
94        return $this->message;
95    }
96
97}