Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00%
28 / 28
100.00%
2 / 2
 CRAP
100.00%
1 / 1
HasCountLessThanEqual
100.00%
28 / 28
100.00%
2 / 2
 16
100.00%
1 / 1
 evaluate
100.00%
17 / 17
100.00%
1 / 1
 11
 generateDefaultMessage
100.00%
11 / 11
100.00%
1 / 1
 5
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 count less than or equal 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 HasCountLessThanEqual 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        $result = false;
49
50        if (!is_array($input)) {
51            throw new Exception('Error: The evaluated input must be an array.');
52        }
53        if (!is_array($this->value) || !is_numeric(reset($this->value))) {
54            throw new Exception("Error: The evaluated value must be an array of node name and count value, e.g. ['node' => 3].");
55        }
56
57        $field = array_key_first($this->value);
58        $count = reset($this->value);
59
60        // Set the default message
61        if (!$this->hasMessage()) {
62            $this->generateDefaultMessage();
63        }
64
65        if (!str_contains($field, '.')) {
66            return (array_key_exists($field, $this->input) &&
67                is_array($this->input[$field]) && count($this->input[$field]) <= $count);
68        } else {
69            $value = [];
70            self::traverseData($field, $this->input, $value);
71
72            return (is_array($value) && (isset($value[0])) && (count($value[0]) <= $count));
73        }
74    }
75
76    /**
77     * Generate default message
78
79     * @param  mixed $name
80     * @param  mixed $value
81     * @return string
82     */
83    public function generateDefaultMessage(mixed $name = null, mixed $value = null): string
84    {
85        $field = null;
86        $count = null;
87
88        if (($value !== null) && is_array($value)) {
89            $field = array_key_first($value);
90            $count = reset($value);
91        } else if ($this->value !== null) {
92            $field = array_key_first($this->value);
93            $count = reset($this->value);
94        }
95
96        $this->message = "The " . (($name !== null) ? "'" . $name . "'" : "array") .
97            " must have a field '" . $field . "' with at most " . $count . " item(s).";
98
99        return $this->message;
100    }
101
102}