Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
92.86%
13 / 14
50.00%
1 / 2
 CRAP
0.00%
0 / 1
NotEqual
92.86%
13 / 14
50.00%
1 / 2
 9.03
0.00%
0 / 1
 evaluate
100.00%
6 / 6
100.00%
1 / 1
 4
 generateDefaultMessage
87.50%
7 / 8
0.00%
0 / 1
 5.05
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 * Not 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 NotEqual extends AbstractValidator
28{
29
30    /**
31     * Method to evaluate the validator
32     *
33     * @param  mixed $input
34     * @return bool
35     */
36    public function evaluate(mixed $input = null): bool
37    {
38        // Set the input, if passed
39        if ($input !== null) {
40            $this->input = $input;
41        }
42
43        // Set the default message
44
45        if (!$this->hasMessage()) {
46            $this->generateDefaultMessage();
47        }
48
49        $inputValue = ($this->hasKeyField()) ? $this->getKeyFieldValue() : $this->input;
50
51        return ($inputValue != $this->value);
52    }
53
54    /**
55     * Generate default message
56
57     * @param  mixed $name
58     * @param  mixed $value
59     * @return string
60     */
61    public function generateDefaultMessage(mixed $name = null, mixed $value = null): string
62    {
63        if ($value !== null) {
64            $valueString = $value;
65        } else if (!empty($this->value) && !is_array($this->value)) {
66            $valueString = $this->value;
67        } else {
68            $valueString = 'the value.';
69        }
70        $this->message = "The " . (($name !== null) ? "'" . $name . "'" : "input") .
71            " must not be equal to '" . $valueString . "'.";
72
73        return $this->message;
74    }
75
76}