Add Extbase 1.0.1 to TYPO3core. Do NOT make changes inside! See misc/core_svn_rules...
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Validation / Validator / StringLengthValidator.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
6 * All rights reserved
7 *
8 * This class is a backport of the corresponding class of FLOW3.
9 * All credits go to the v5 team.
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 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Validator for string length
30 *
31 * @package Extbase
32 * @subpackage Validation\Validator
33 * @version $Id: StringLengthValidator.php 1052 2009-08-05 21:51:32Z sebastian $
34 * @scope prototype
35 */
36 class Tx_Extbase_Validation_Validator_StringLengthValidator extends Tx_Extbase_Validation_Validator_AbstractValidator {
37
38 /**
39 * Returns TRUE, if the given property ($value) is a valid string and its length
40 * is between 'minimum' (defaults to 0 if not specified) and 'maximum' (defaults to infinite if not specified)
41 * to be specified in the validation options.
42 *
43 * If at least one error occurred, the result is FALSE.
44 *
45 * @param mixed $value The value that should be validated
46 * @return boolean TRUE if the value is valid, FALSE if an error occured
47 */
48 public function isValid($value) {
49 $this->errors = array();
50 if (isset($this->options['minimum']) && isset($this->options['maximum'])
51 && $this->options['maximum'] < $this->options['minimum']) {
52 throw new Tx_Extbase_Validation_Exception_InvalidValidationOptions('The \'maximum\' is shorter than the \'minimum\' in the StringLengthValidator.', 1238107096);
53 }
54
55 if (is_object($value) && !method_exists($value, '__toString')) throw new Tx_Extbase_Validation_Exception_InvalidSubject('The given object could not be converted to a string.', 1238110957);
56
57 // TODO Use t3lib_cs::strlen() instead; How do we get the charset?
58 $stringLength = strlen($value);
59 $isValid = TRUE;
60 if (isset($this->options['minimum']) && $stringLength < $this->options['minimum']) $isValid = FALSE;
61 if (isset($this->options['maximum']) && $stringLength > $this->options['maximum']) $isValid = FALSE;
62
63 if ($isValid === FALSE) {
64 if (isset($this->options['minimum']) && isset($this->options['maximum'])) {
65 $this->addError('The length of the given string was not between ' . $this->options['minimum'] . ' and ' . $this->options['maximum'] . ' characters.', 1238108067);
66 } elseif (isset($this->options['minimum'])) {
67 $this->addError('The length of the given string less than ' . $this->options['minimum'] . ' characters.', 1238108068);
68 } else {
69 $this->addError('The length of the given string exceeded ' . $this->options['maximum'] . ' characters.', 1238108069);
70 }
71 }
72
73 return $isValid;
74 }
75 }
76
77 ?>