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