|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Yiisoft\Validator\Rule; |
|
6
|
|
|
|
|
7
|
|
|
use Attribute; |
|
8
|
|
|
use Closure; |
|
9
|
|
|
use JetBrains\PhpStorm\Language; |
|
10
|
|
|
use RuntimeException; |
|
11
|
|
|
use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait; |
|
12
|
|
|
use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait; |
|
13
|
|
|
use Yiisoft\Validator\Rule\Trait\WhenTrait; |
|
14
|
|
|
use Yiisoft\Validator\SerializableRuleInterface; |
|
15
|
|
|
use Yiisoft\Validator\SkipOnEmptyInterface; |
|
16
|
|
|
use Yiisoft\Validator\SkipOnErrorInterface; |
|
17
|
|
|
use Yiisoft\Validator\ValidationContext; |
|
18
|
|
|
use Yiisoft\Validator\WhenInterface; |
|
19
|
|
|
|
|
20
|
|
|
use function function_exists; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* Validates that the value is a valid email address. |
|
24
|
|
|
*/ |
|
25
|
|
|
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)] |
|
26
|
|
|
final class Email implements SerializableRuleInterface, SkipOnErrorInterface, WhenInterface, SkipOnEmptyInterface |
|
27
|
|
|
{ |
|
28
|
|
|
use SkipOnEmptyTrait; |
|
29
|
|
|
use SkipOnErrorTrait; |
|
30
|
|
|
use WhenTrait; |
|
31
|
|
|
|
|
32
|
3 |
|
public function __construct( |
|
33
|
|
|
#[Language('RegExp')] |
|
34
|
|
|
/** |
|
35
|
|
|
* @var string the regular expression used to validate value. |
|
36
|
|
|
* |
|
37
|
|
|
* @link http://www.regular-expressions.info/email.html |
|
38
|
|
|
*/ |
|
39
|
|
|
private string $pattern = '/^[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$/', |
|
40
|
|
|
#[Language('RegExp')] |
|
41
|
|
|
/** |
|
42
|
|
|
* @var string the regular expression used to validate email addresses with the name part. This property is used |
|
43
|
|
|
* only when {@see $allowName} is `true`. |
|
44
|
|
|
* |
|
45
|
|
|
* @see $allowName |
|
46
|
|
|
*/ |
|
47
|
|
|
private string $fullPattern = '/^[^@]*<[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+\\/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?>$/', |
|
48
|
|
|
#[Language('RegExp')] |
|
49
|
|
|
/** |
|
50
|
|
|
* @var string the regular expression used to validate complex emails when {@see $enableIDN} is `true`. |
|
51
|
|
|
*/ |
|
52
|
|
|
private string $idnEmailPattern = '/^([a-zA-Z0-9._%+-]+)@((\[\d{1,3}\.\d{1,3}\.\d{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|\d{1,3})(\]?)$/', |
|
53
|
|
|
/** |
|
54
|
|
|
* @var bool whether to allow name in the email address (e.g. "John Smith <[email protected]>"). Defaults |
|
55
|
|
|
* to `false`. |
|
56
|
|
|
* |
|
57
|
|
|
* @see $fullPattern |
|
58
|
|
|
*/ |
|
59
|
|
|
private bool $allowName = false, |
|
60
|
|
|
/** |
|
61
|
|
|
* @var bool whether to check whether the email's domain exists and has either an A or MX record. |
|
62
|
|
|
* Be aware that this check can fail due to temporary DNS problems even if the email address is |
|
63
|
|
|
* valid and an email would be deliverable. Defaults to `false`. |
|
64
|
|
|
*/ |
|
65
|
|
|
private bool $checkDNS = false, |
|
66
|
|
|
/** |
|
67
|
|
|
* @var bool whether validation process should take into account IDN (internationalized domain |
|
68
|
|
|
* names). Defaults to false meaning that validation of emails containing IDN will always fail. |
|
69
|
|
|
* Note that in order to use IDN validation you have to install and enable `intl` PHP extension, |
|
70
|
|
|
* otherwise an exception would be thrown. |
|
71
|
|
|
*/ |
|
72
|
|
|
private bool $enableIDN = false, |
|
73
|
|
|
private string $incorrectInputMessage = 'The value must have a string type.', |
|
74
|
|
|
private string $message = 'This value is not a valid email address.', |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* @var bool|callable|null |
|
78
|
|
|
*/ |
|
79
|
|
|
private $skipOnEmpty = null, |
|
80
|
|
|
private bool $skipOnError = false, |
|
81
|
|
|
/** |
|
82
|
|
|
* @var Closure(mixed, ValidationContext):bool|null |
|
83
|
|
|
*/ |
|
84
|
|
|
private ?Closure $when = null, |
|
85
|
|
|
) { |
|
86
|
3 |
|
if ($enableIDN && !function_exists('idn_to_ascii')) { |
|
87
|
|
|
// Tested via separate CI configuration (see ".github/workflows/build.yml"). |
|
88
|
|
|
// @codeCoverageIgnoreStart |
|
89
|
|
|
throw new RuntimeException('In order to use IDN validation intl extension must be installed and enabled.'); |
|
90
|
|
|
// @codeCoverageIgnoreEnd |
|
91
|
|
|
} |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
1 |
|
public function getName(): string |
|
95
|
|
|
{ |
|
96
|
1 |
|
return 'email'; |
|
97
|
|
|
} |
|
98
|
|
|
|
|
99
|
81 |
|
public function getPattern(): string |
|
100
|
|
|
{ |
|
101
|
81 |
|
return $this->pattern; |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
20 |
|
public function getFullPattern(): string |
|
105
|
|
|
{ |
|
106
|
20 |
|
return $this->fullPattern; |
|
107
|
|
|
} |
|
108
|
|
|
|
|
109
|
10 |
|
public function getIdnEmailPattern(): string |
|
110
|
|
|
{ |
|
111
|
10 |
|
return $this->idnEmailPattern; |
|
112
|
|
|
} |
|
113
|
|
|
|
|
114
|
48 |
|
public function isAllowName(): bool |
|
115
|
|
|
{ |
|
116
|
48 |
|
return $this->allowName; |
|
117
|
|
|
} |
|
118
|
|
|
|
|
119
|
46 |
|
public function isCheckDNS(): bool |
|
120
|
|
|
{ |
|
121
|
46 |
|
return $this->checkDNS; |
|
122
|
|
|
} |
|
123
|
|
|
|
|
124
|
92 |
|
public function isEnableIDN(): bool |
|
125
|
|
|
{ |
|
126
|
92 |
|
return $this->enableIDN; |
|
127
|
|
|
} |
|
128
|
|
|
|
|
129
|
2 |
|
public function getIncorrectInputMessage(): string |
|
130
|
|
|
{ |
|
131
|
2 |
|
return $this->incorrectInputMessage; |
|
132
|
|
|
} |
|
133
|
|
|
|
|
134
|
47 |
|
public function getMessage(): string |
|
135
|
|
|
{ |
|
136
|
47 |
|
return $this->message; |
|
137
|
|
|
} |
|
138
|
|
|
|
|
139
|
4 |
|
public function getOptions(): array |
|
140
|
|
|
{ |
|
141
|
|
|
return [ |
|
142
|
4 |
|
'pattern' => $this->pattern, |
|
143
|
4 |
|
'fullPattern' => $this->fullPattern, |
|
144
|
4 |
|
'idnEmailPattern' => $this->idnEmailPattern, |
|
145
|
4 |
|
'allowName' => $this->allowName, |
|
146
|
4 |
|
'checkDNS' => $this->checkDNS, |
|
147
|
4 |
|
'enableIDN' => $this->enableIDN, |
|
148
|
|
|
'incorrectInputMessage' => [ |
|
149
|
4 |
|
'message' => $this->incorrectInputMessage, |
|
150
|
|
|
], |
|
151
|
|
|
'message' => [ |
|
152
|
4 |
|
'message' => $this->message, |
|
153
|
|
|
], |
|
154
|
4 |
|
'skipOnEmpty' => $this->getSkipOnEmptyOption(), |
|
155
|
4 |
|
'skipOnError' => $this->skipOnError, |
|
156
|
|
|
]; |
|
157
|
|
|
} |
|
158
|
|
|
|
|
159
|
94 |
|
public function getHandlerClassName(): string |
|
160
|
|
|
{ |
|
161
|
94 |
|
return EmailHandler::class; |
|
162
|
|
|
} |
|
163
|
|
|
} |
|
164
|
|
|
|
yiisoft /
validator
