[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Validation / Validator / EmailAddressValidator.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Validation\Validator;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Validator for email addresses
19 */
20 class EmailAddressValidator extends AbstractValidator
21 {
22 /**
23 * Checks if the given value is a valid email address.
24 *
25 * @param mixed $value The value that should be validated
26 */
27 public function isValid($value)
28 {
29 if (!is_string($value) || !$this->validEmail($value)) {
30 $this->addError(
31 $this->translateErrorMessage(
32 'validator.emailaddress.notvalid',
33 'extbase'
34 ),
35 1221559976
36 );
37 }
38 }
39
40 /**
41 * Checking syntax of input email address
42 *
43 * @param string $emailAddress Input string to evaluate
44 * @return bool Returns TRUE if the $email address (input string) is valid
45 */
46 protected function validEmail($emailAddress)
47 {
48 return \TYPO3\CMS\Core\Utility\GeneralUtility::validEmail($emailAddress);
49 }
50 }