[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Validation / Validator / RegularExpressionValidator.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 based on regular expressions.
19 */
20 class RegularExpressionValidator extends AbstractValidator
21 {
22 /**
23 * @var array
24 */
25 protected $supportedOptions = [
26 'regularExpression' => ['', 'The regular expression to use for validation, used as given', 'string', true]
27 ];
28
29 /**
30 * Checks if the given value matches the specified regular expression.
31 *
32 * @param mixed $value The value that should be validated
33 * @throws \TYPO3\CMS\Extbase\Validation\Exception\InvalidValidationOptionsException
34 */
35 public function isValid($value)
36 {
37 $result = preg_match($this->options['regularExpression'], $value);
38 if ($result === 0) {
39 $this->addError(
40 $this->translateErrorMessage(
41 'validator.regularexpression.nomatch',
42 'extbase'
43 ),
44 1221565130
45 );
46 }
47 if ($result === false) {
48 throw new \TYPO3\CMS\Extbase\Validation\Exception\InvalidValidationOptionsException('regularExpression "' . $this->options['regularExpression'] . '" in RegularExpressionValidator contained an error.', 1298273089);
49 }
50 }
51 }