1 <?php
2
3 /**
4 * The MIT License
5 *
6 * Copyright 2014 George Marques <george at georgemarques.com.br>.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
26
27 namespace Flikore\Validator\Validators;
28
29 /**
30 * Validates if a value is equal to another.
31 *
32 * @customKey <i>%compare%</i> The value to be compared to.
33 * @customKey <i>%strict%</i> Whether the comparison is done in strict form.
34 *
35 * @author George Marques <george at georgemarques.com.br>
36 * @version 0.5.2
37 * @since 0.3
38 * @license http://opensource.org/licenses/MIT MIT
39 * @copyright (c) 2014, George Marques
40 * @package Flikore\Validator
41 */
42 class EqualsValidator extends \Flikore\Validator\Validator
43 {
44
45 /**
46 * The error message for this validator.
47 * @var string The error message for this validator.
48 */
49 protected $message = 'The %key% must be equal to "%compare%".';
50
51 /**
52 * The value to be compared to.
53 * @var mixed The value to be compared to.
54 */
55 protected $compare;
56
57 /**
58 * Whether the comparison should be done in strict form.
59 * @var boolean Whether the comparison should be done in strict form.
60 */
61 protected $strict;
62
63 /**
64 * Creates a new Equals Validator.
65 * @param mixed $compare The value to compare to.
66 * @param boolean $strict Whether the comparison should be strict.
67 */
68 public function __construct($compare, $strict = false)
69 {
70 $this->compare = $compare;
71 $this->strict = (bool) $strict;
72
73 $this->addKeyValue('compare', $compare);
74 $this->addKeyValue('strict', $strict ? 'true' : 'false');
75 }
76
77 /**
78 * Executes the real validation so it can be reused.
79 * @param mixed $value The value to validate.
80 * @return boolean Whether the value pass the validation.
81 */
82 protected function doValidate($value)
83 {
84 // ignore empty values
85 if ($this->isEmpty($value))
86 {
87 return true;
88 }
89 return $this->strict ? ($value === $this->compare) : ($value == $this->compare);
90 }
91
92 }
93