|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* TechDivision\Import\Callbacks\DatetimeValidatorCallback |
|
5
|
|
|
* |
|
6
|
|
|
* NOTICE OF LICENSE |
|
7
|
|
|
* |
|
8
|
|
|
* This source file is subject to the Open Software License (OSL 3.0) |
|
9
|
|
|
* that is available through the world-wide-web at this URL: |
|
10
|
|
|
* http://opensource.org/licenses/osl-3.0.php |
|
11
|
|
|
* |
|
12
|
|
|
* PHP version 5 |
|
13
|
|
|
* |
|
14
|
|
|
* @author Tim Wagner <[email protected]> |
|
15
|
|
|
* @copyright 2019 TechDivision GmbH <[email protected]> |
|
16
|
|
|
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) |
|
17
|
|
|
* @link https://github.com/techdivision/import-product |
|
18
|
|
|
* @link http://www.techdivision.com |
|
19
|
|
|
*/ |
|
20
|
|
|
|
|
21
|
|
|
namespace TechDivision\Import\Callbacks; |
|
22
|
|
|
|
|
23
|
|
|
use TechDivision\Import\Subjects\SubjectInterface; |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* A callback implementation that validates the value is a valid date. |
|
27
|
|
|
* |
|
28
|
|
|
* @author Tim Wagner <[email protected]> |
|
29
|
|
|
* @copyright 2019 TechDivision GmbH <[email protected]> |
|
30
|
|
|
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) |
|
31
|
|
|
* @link https://github.com/techdivision/import-product |
|
32
|
|
|
* @link http://www.techdivision.com |
|
33
|
|
|
*/ |
|
34
|
|
|
class DatetimeValidatorCallback implements CallbackInterface, CallbackFactoryInterface |
|
35
|
|
|
{ |
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* The flag to query whether or not the value can be empty. |
|
39
|
|
|
* |
|
40
|
|
|
* @var boolean |
|
41
|
|
|
*/ |
|
42
|
|
|
protected $nullable = false; |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* The default source date format. |
|
46
|
|
|
* |
|
47
|
|
|
* @var string |
|
48
|
|
|
*/ |
|
49
|
|
|
protected $sourceDateFormat = 'n/d/y, g:i A'; |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* Initializes the callback with the loader instance. |
|
53
|
|
|
* |
|
54
|
|
|
* @param boolean $nullable The flag to decide whether or not the value can be empty |
|
55
|
|
|
*/ |
|
56
|
|
|
public function __construct($nullable = false) |
|
57
|
|
|
{ |
|
58
|
|
|
$this->nullable = $nullable; |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
/** |
|
62
|
|
|
* Will be invoked by the callback visitor when a factory has been defined to create the callback instance. |
|
63
|
|
|
* |
|
64
|
|
|
* @param \TechDivision\Import\Subjects\SubjectInterface $subject The subject instance |
|
65
|
|
|
* |
|
66
|
|
|
* @return \TechDivision\Import\Callbacks\CallbackInterface The callback instance |
|
67
|
|
|
*/ |
|
68
|
|
|
public function createCallback(SubjectInterface $subject) |
|
69
|
|
|
{ |
|
70
|
|
|
|
|
71
|
|
|
// load the source date format from the subject's date converter configuration |
|
72
|
|
|
$this->sourceDateFormat = $subject->getSourceDateFormat(); |
|
73
|
|
|
|
|
74
|
|
|
// return the initialized instance |
|
75
|
|
|
return $this; |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* Query whether or not the passed value IS empty and empty values are allowed. |
|
80
|
|
|
* |
|
81
|
|
|
* @param string $attributeValue The attribute value to query for |
|
82
|
|
|
* |
|
83
|
|
|
* @return boolean TRUE if empty values are allowed and the passed value IS empty |
|
84
|
|
|
*/ |
|
85
|
|
|
protected function isNullable($attributeValue) |
|
86
|
|
|
{ |
|
87
|
|
|
return $this->nullable && ($attributeValue === '' || $attributeValue === null); |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
/** |
|
91
|
|
|
* Query whether or not the passed value IS a valid date. |
|
92
|
|
|
* |
|
93
|
|
|
* @param string $attributeValue The attribute value to query for |
|
94
|
|
|
* |
|
95
|
|
|
* @return boolean TRUE if the passed value IS a valid date |
|
96
|
|
|
*/ |
|
97
|
|
|
protected function isDate($attributeValue) |
|
98
|
|
|
{ |
|
99
|
|
|
return \DateTime::createFromFormat($this->sourceDateFormat, $attributeValue); |
|
100
|
|
|
} |
|
101
|
|
|
|
|
102
|
|
|
/** |
|
103
|
|
|
* Will be invoked by the observer it has been registered for. |
|
104
|
|
|
* |
|
105
|
|
|
* @param string|null $attributeCode The code of the attribute that has to be validated |
|
106
|
|
|
* @param string|null $attributeValue The attribute value to be validated |
|
107
|
|
|
* |
|
108
|
|
|
* @return mixed The modified value |
|
109
|
|
|
*/ |
|
110
|
|
View Code Duplication |
public function handle($attributeCode = null, $attributeValue = null) |
|
|
|
|
|
|
111
|
|
|
{ |
|
112
|
|
|
|
|
113
|
|
|
// query whether or not we've found a value and it is a valid date |
|
114
|
|
|
if ($this->isNullable($attributeValue) || $this->isDate($attributeValue)) { |
|
115
|
|
|
return; |
|
116
|
|
|
} |
|
117
|
|
|
|
|
118
|
|
|
// throw an exception if the value is NOT in the array |
|
119
|
|
|
throw new \InvalidArgumentException( |
|
120
|
|
|
sprintf( |
|
121
|
|
|
'Found invalid date "%s" for column "%s"', |
|
122
|
|
|
$attributeValue, |
|
123
|
|
|
$attributeCode |
|
124
|
|
|
) |
|
125
|
|
|
); |
|
126
|
|
|
} |
|
127
|
|
|
} |
|
128
|
|
|
|
techdivision /
import
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.