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 string matches a given regular expression
31 *
32 * @customKey <i>%regex%</i> The regular expression to be matched.
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 RegexValidator extends \Flikore\Validator\Validator
42 {
43
44 /**
45 * The regex to match.
46 * @var string The regex to match.
47 */
48 protected $regex;
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 match the regular expression "%regex%".';
55
56 /**
57 * Creates a new Regex Validator.
58 * @param string $regex The regex to match.
59 */
60 public function __construct($regex)
61 {
62 $test = @preg_match($regex, 'test');
63 if ($test === false)
64 {
65 throw new \InvalidArgumentException(sprintf('"%s" is not a valid regular expression', $regex));
66 }
67
68 $this->regex = $regex;
69
70 $this->addKeyValue('regex', $regex);
71 }
72
73 /**
74 * Executes the real validation so it can be reused.
75 * @param mixed $value The value to validate.
76 * @return boolean Whether the value pass the validation.
77 */
78 protected function doValidate($value)
79 {
80 // ignore empty values
81 if ($this->isEmpty($value))
82 {
83 return true;
84 }
85 if(!is_string($value))
86 {
87 return false;
88 }
89 return (bool) (preg_match($this->regex, $value));
90 }
91
92 }
93