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 a valid date/time.
31 *
32 * @customKey <i>%format%</i> The format specified to check the valid date/time.
33 *
34 * @author George Marques <george at georgemarques.com.br>
35 * @version 0.5.2
36 * @since 0.4.0
37 * @license http://opensource.org/licenses/MIT MIT
38 * @copyright (c) 2014, George Marques
39 * @package Flikore\Validator
40 */
41 class DateTimeValidator extends \Flikore\Validator\Validator
42 {
43
44 /**
45 * The format of the date/time.
46 * @var string The format of the date/time.
47 */
48 protected $format;
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 be a valid date/time.';
55
56 /**
57 * The alternative message used if there is a specified format.
58 * @var string The alternative message used if there is a specified format.
59 */
60 protected $alt_message = 'The %key% must be a date/time in the format "%format%".';
61
62 /**
63 * Creates a new Date Validator.
64 * @param string $format The format of the date/time (if any).
65 */
66 public function __construct($format = null)
67 {
68 if (!is_null($format) && !is_string($format))
69 {
70 throw new \InvalidArgumentException('The format must be a string if not null.');
71 }
72
73 $this->format = $format;
74
75 if ($format !== null)
76 {
77 $this->addKeyValue('format', $format);
78 $this->setErrorMessage($this->alt_message);
79 }
80 }
81
82 /**
83 * Executes the real validation so it can be reused.
84 * @param mixed $value The value to validate.
85 * @return boolean Whether the value pass the validation.
86 */
87 protected function doValidate($value)
88 {
89 // ignore empty values
90 if ($this->isEmpty($value))
91 {
92 return true;
93 }
94 if ($value instanceof \DateTime)
95 {
96 return true;
97 }
98 if (!is_string($value))
99 {
100 return false;
101 }
102 if (is_null($this->format))
103 {
104 return (strtotime($value) !== false);
105 }
106 $date = \DateTime::createFromFormat($this->format, $value);
107 return $date && $value === date($this->format, $date->getTimestamp());
108 }
109
110 }
111