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 that the value is between a certain range.
31 *
32 * @customKey <i>%min%</i> The minimum valid value.
33 * @customKey <i>%max%</i> The maximum valid value.
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 ValueBetweenValidator extends \Flikore\Validator\Validator
43 {
44
45 /**
46 * The minimum valid value.
47 * @var int The minimum valid value.
48 */
49 protected $min;
50
51 /**
52 * The maximum valid value.
53 * @var int The maximum valid value.
54 */
55 protected $max;
56
57 /**
58 * The error message for this validator.
59 * @var string The error message for this validator.
60 */
61 protected $message = 'The %key% must be between %min% and %max%.';
62
63 /**
64 * Creates a new Value Between Validator.
65 * @param int $min The minimum valid value.
66 * @param int $max The maximum valid value.
67 */
68 public function __construct($min, $max)
69 {
70 if (!is_int($min))
71 {
72 throw new \InvalidArgumentException('The minimum must be a valid integer');
73 }
74 if (!is_int($max))
75 {
76 throw new \InvalidArgumentException('The maximum must be a valid integer');
77 }
78
79 $this->min = $min;
80 $this->max = $max;
81
82 $this->addKeyValue('min', $min);
83 $this->addKeyValue('max', $max);
84 }
85
86 /**
87 * Executes the real validation so it can be reused.
88 * @param mixed $value The value to validate.
89 * @return boolean Whether the value pass the validation.
90 */
91 protected function doValidate($value)
92 {
93 // ignore empty values
94 if ($this->isEmpty($value))
95 {
96 return true;
97 }
98 return is_numeric($value) && (($value >= $this->min) && ($value <= $this->max));
99 }
100
101 }
102