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