[BUGFIX] Correctly apply Extbase validator options and add tests
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Validation / Validator / BooleanValidator.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Validation\Validator;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2013 Pascal Dürsteler <pascal.duersteler@gmail.com>
8 * Extbase is a backport of TYPO3 Flow. 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 text file 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 boolean values
32 */
33 class BooleanValidator extends \TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator {
34
35 /**
36 * @var array
37 */
38 protected $supportedOptions = array(
39 // The default is set to NULL here, because we need to be backward compatible here, because this
40 // BooleanValidator is called automatically on boolean action arguments. If we would set it to TRUE,
41 // every FALSE value for an action argument would break.
42 // TODO with next patches: deprecate this BooleanValidator and introduce a BooleanValueValidator, like
43 // in Flow, which won't be called on boolean action arguments.
44 'is' => array(NULL, 'Boolean value', 'boolean|string|integer')
45 );
46
47
48 /**
49 * Returns TRUE if the given property value is a boolean matching the expectation.
50 *
51 * If at least one error occurred, the result is FALSE.
52 *
53 * Also testing for '1' (true), '0' and '' (false) because casting varies between
54 * tests and actual usage. This makes the validator loose but still keeping functionality.
55 *
56 * @param mixed $value The value that should be validated
57 * @return boolean TRUE if the value is within the range, otherwise FALSE
58 */
59 public function isValid($value) {
60 // see comment above, check if expectation is NULL, then nothing to do!
61 if ($this->options['is'] === NULL) {
62 return;
63 }
64 switch (strtolower((string)$this->options['is'])) {
65 case 'true':
66 case '1':
67 $expectation = TRUE;
68 break;
69 case 'false':
70 case '':
71 case '0':
72 $expectation = FALSE;
73 break;
74 default:
75 $this->addError('The given expectation is not valid.', 1361959227);
76 return;
77 }
78
79 if ($value !== $expectation) {
80 if (!is_bool($value)) {
81 $this->addError('The given subject is not true.', 1361959230);
82 } else {
83 if ($expectation) {
84 $this->addError('The given subject is not true.', 1361959228);
85 } else {
86 $this->addError('The given subject is not false.', 1361959229);
87 }
88 }
89 }
90 }
91
92 }