Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
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@nolainteractive.com>
7 * @copyright  Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)
8 * @license    http://www.popphp.org/license     New BSD License
9 */
10
11/**
12 * @namespace
13 */
14namespace Pop\Validator;
15
16/**
17 * Validator interface
18 *
19 * @category   Pop
20 * @package    Pop\Validator
21 * @author     Nick Sagona, III <dev@nolainteractive.com>
22 * @copyright  Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)
23 * @license    http://www.popphp.org/license     New BSD License
24 * @version    4.0.0
25 */
26interface ValidatorInterface
27{
28
29    /**
30     * Get the validator value
31     *
32     * @return mixed
33     */
34    public function getValue(): mixed;
35
36    /**
37     * Get the validator default message
38     *
39     * @return string|null
40     */
41    public function getMessage(): string|null;
42
43    /**
44     * Get the validator input
45     *
46     * @return mixed
47     */
48    public function getInput(): mixed;
49
50    /**
51     * Set the validator value
52     *
53     * @param  mixed $value
54     * @return ValidatorInterface
55     */
56    public function setValue(mixed $value): ValidatorInterface;
57
58    /**
59     * Set the validator default message
60     *
61     * @param  ?string $message
62     * @return ValidatorInterface
63     */
64    public function setMessage(?string $message = null): ValidatorInterface;
65
66    /**
67     * Set the validator input
68     *
69     * @param  mixed $input
70     * @return ValidatorInterface
71     */
72    public function setInput(mixed $input = null): ValidatorInterface;
73
74    /**
75     * Evaluate
76     *
77     * @param  mixed $input
78     * @return bool
79     */
80    public function evaluate(mixed $input = null): bool;
81
82}