Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00%
17 / 17
100.00%
1 / 1
 CRAP
100.00%
1 / 1
Required
100.00%
17 / 17
100.00%
1 / 1
 9
100.00%
1 / 1
 evaluate
100.00%
17 / 17
100.00%
1 / 1
 9
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 * Required validator class (alias 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 Required 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        // Set the default message
49        if ($this->message === null) {
50            $this->message = "The '" . $this->value . "' field is required." ;
51        }
52
53        if (!is_array($input)) {
54            throw new Exception('Error: The evaluated input must be an array.');
55        }
56        if (empty($this->value)) {
57            throw new Exception('Error: The evaluated value cannot be empty.');
58        }
59
60        if (!str_contains($this->value, '.')) {
61            return (array_key_exists($this->value, $this->input));
62        } else {
63            $parentValues = [];
64            $childValues  = [];
65
66            self::traverseData(substr($this->value, 0, strrpos($this->value, '.')), $this->input, $parentValues);
67            self::traverseData($this->value, $this->input, $childValues);
68
69            if (isset($parentValues[0][0])) {
70                $parentValues = $parentValues[0];
71            }
72            return (is_array($parentValues) && is_array($childValues) && (count($parentValues) == count($childValues)));
73        }
74    }
75
76}