[TASK] Make preperations for backporting Flow validation api
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Validation / Validator / AbstractCompositeValidator.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Validation\Validator;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2010-2013 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
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 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 * An abstract composite validator with consisting of other validators
32 *
33 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
34 */
35 abstract class AbstractCompositeValidator implements \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface, \Countable {
36
37 /**
38 * This contains the supported options, their default values and descriptions.
39 *
40 * @var array
41 */
42 protected $supportedOptions = array();
43
44 /**
45 * @var array
46 */
47 protected $options = array();
48
49 /**
50 * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage
51 */
52 protected $validators;
53
54 /**
55 * @var \SplObjectStorage
56 */
57 protected $validatedInstancesContainer;
58
59 /**
60 * @var array
61 */
62 protected $errors = array();
63
64 /**
65 * Constructs the composite validator and sets validation options
66 *
67 * @api
68 */
69 public function __construct() {
70 $this->validators = new \TYPO3\CMS\Extbase\Persistence\ObjectStorage();
71 }
72
73 /**
74 * Does nothing.
75 *
76 * @param array $options Not used
77 * @return void
78 * @deprecated since Extbase 1.4.0, will be removed two versions after Extbase 6.1
79 */
80 public function setOptions(array $options) {
81 }
82
83 /**
84 * Returns an array of errors which occurred during the last isValid() call.
85 *
86 * @return array An array of \TYPO3\CMS\Extbase\Validation\Error objects or an empty array if no errors occurred.
87 * @deprecated since Extbase 1.4.0, will be removed two versions after Extbase 6.1
88 */
89 public function getErrors() {
90 return $this->errors;
91 }
92
93 /**
94 * Adds a new validator to the conjunction.
95 *
96 * @param \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $validator The validator that should be added
97 * @return void
98 * @api
99 */
100 public function addValidator(\TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $validator) {
101 $this->validators->attach($validator);
102 }
103
104 /**
105 * Removes the specified validator.
106 *
107 * @param \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $validator The validator to remove
108 * @throws \TYPO3\CMS\Extbase\Validation\Exception\NoSuchValidatorException
109 * @return void
110 */
111 public function removeValidator(\TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $validator) {
112 if (!$this->validators->contains($validator)) {
113 throw new \TYPO3\CMS\Extbase\Validation\Exception\NoSuchValidatorException('Cannot remove validator because its not in the conjunction.', 1207020177);
114 }
115 $this->validators->detach($validator);
116 }
117
118 /**
119 * Returns the number of validators contained in this conjunction.
120 *
121 * @return integer The number of validators
122 * @api
123 */
124 public function count() {
125 return count($this->validators);
126 }
127
128 /**
129 * Returns the child validators of this Composite Validator
130 *
131 * @return \SplObjectStorage
132 */
133 public function getValidators() {
134 return $this->validators;
135 }
136
137 /**
138 * Returns the options for this validator
139 *
140 * @return array
141 */
142 public function getOptions() {
143 return $this->options;
144 }
145
146 /**
147 * Allows to set a container to keep track of validated instances.
148 *
149 * @param \SplObjectStorage $validatedInstancesContainer A container to keep track of validated instances
150 * @return void
151 * @api
152 */
153 public function setValidatedInstancesContainer(\SplObjectStorage $validatedInstancesContainer) {
154 $this->validatedInstancesContainer = $validatedInstancesContainer;
155 }
156 }
157
158 ?>