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 number of characters of the value is at most a given amount.
31 *
32 * @customKey <i>%max%</i> The maximum valid length.
33 *
34 * @author George Marques <george at georgemarques.com.br>
35 * @version 0.5.2
36 * @since 0.2
37 * @license http://opensource.org/licenses/MIT MIT
38 * @copyright (c) 2014, George Marques
39 * @package Flikore\Validator
40 */
41 class MaxLengthValidator extends \Flikore\Validator\Validator
42 {
43
44 /**
45 * The maximum valid length.
46 * @var int The maximum valid length.
47 */
48 protected $max;
49
50 /**
51 * The error message for this validator.
52 * @var string The error message for this validator.
53 */
54 protected $message = 'The %key% must have at most %max% characters.';
55
56 /**
57 * Creates a new Max Length Validator.
58 * @param int $max The maximum valid length.
59 */
60 public function __construct($max)
61 {
62 if (!is_int($max))
63 {
64 throw new \InvalidArgumentException('The maximum must be a valid integer');
65 }
66
67 $this->max = $max;
68
69 $this->addKeyValue('max', $max);
70 }
71
72 /**
73 * Executes the real validation so it can be reused.
74 * @param mixed $value The value to validate.
75 * @return boolean Whether the value pass the validation.
76 */
77 protected function doValidate($value)
78 {
79 // ignore empty values
80 if ($this->isEmpty($value))
81 {
82 return true;
83 }
84 return (strlen($value) <= $this->max);
85 }
86
87 }
88