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/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2016 (original work) Open Assessment Technologies SA;
19 *
20 */
21
22namespace oat\oatbox\validator;
23
24/**
25 * validator base interface
26 * @author Christophe GARCIA <christopheg@taotesting.com>
27 */
28interface ValidatorInterface
29{
30    /**
31     * return validator name
32     * @return string
33     */
34    public function getName();
35
36    /**
37     * return validator options
38     * @return array
39     */
40    public function getOptions();
41
42    /**
43     * return error message
44     * @return string
45     */
46    public function getMessage();
47
48    /**
49     * set up error message
50     * @param string $message
51     * @return $this
52     */
53    public function setMessage($message);
54
55    /**
56     * set up validator options
57     * @param array $options
58     * @return $this
59     */
60    public function setOptions(array $options);
61
62    /**
63     * valid $values
64     * @param string $values
65     * @return boolean
66     */
67    public function evaluate($values);
68}