[TASK] Adjust phpdoc for classes (files) of backports
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Validation / Validator / AlphanumericValidator.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Validation\Validator;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * This class is a backport of the corresponding class of TYPO3 Flow.
8 * All credits go to the TYPO3 Flow team.
9 * All rights reserved
10 *
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
19 * A copy is found in the textfile GPL.txt and important notices to the license
20 * from the author is found in LICENSE.txt distributed with these scripts.
21 *
22 *
23 * This script is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
27 *
28 * This copyright notice MUST APPEAR in all copies of the script!
29 ***************************************************************/
30 /**
31 * Validator for alphanumeric strings
32 * @scope prototype
33 */
34 class AlphanumericValidator extends \TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator {
35
36 /**
37 * Returns TRUE, if the given property ($propertyValue) is a valid
38 * alphanumeric string, which is defined as [a-zA-Z0-9]*.
39 *
40 * If at least one error occurred, the result is FALSE.
41 *
42 * @param mixed $value The value that should be validated
43 * @return boolean TRUE if the value is valid, FALSE if an error occured
44 */
45 public function isValid($value) {
46 $this->errors = array();
47 if (is_string($value) && preg_match('/^[a-z0-9]*$/i', $value)) {
48 return TRUE;
49 }
50 $this->addError('The given subject was not a valid alphanumeric string.', 1221551320);
51 return FALSE;
52 }
53
54 }
55
56
57 ?>