[TASK] Adjust phpdoc to namespaces
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Property / MappingResults.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Property;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
8 * All rights reserved
9 *
10 * This class is a backport of the corresponding class of FLOW3.
11 * All credits go to the v5 team.
12 *
13 * This script is part of the TYPO3 project. The TYPO3 project is
14 * free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
18 *
19 * The GNU General Public License can be found at
20 * http://www.gnu.org/copyleft/gpl.html.
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29 /**
30 * The Mapping Results
31 *
32 * @scope prototype
33 * @deprecated since Extbase 1.4.0, will be removed in Extbase 6.1
34 */
35 class MappingResults {
36
37 /**
38 * @var array An array of the occured errors
39 */
40 protected $errors = array();
41
42 /**
43 * @var array An array of the occured warnings
44 */
45 protected $warnings = array();
46
47 /**
48 * Adds an error to the mapping results. This might be for example a
49 * validation or mapping error
50 *
51 * @param \TYPO3\CMS\Extbase\Error\Error $error The occured error
52 * @param string $propertyName The name of the property which caused the error
53 */
54 public function addError(\TYPO3\CMS\Extbase\Error\Error $error, $propertyName) {
55 $this->errors[$propertyName] = $error;
56 }
57
58 /**
59 * Returns all errors that occured so far
60 *
61 * @return array Array of \TYPO3\CMS\Extbase\Error\Error
62 */
63 public function getErrors() {
64 return $this->errors;
65 }
66
67 /**
68 * Returns true if any error was recognized
69 *
70 * @return boolean True if an error occured
71 */
72 public function hasErrors() {
73 return count($this->errors) > 0;
74 }
75
76 /**
77 * Adds a warning to the mapping results. This might be for example a
78 * property that could not be mapped but wasn't marked as required.
79 *
80 * @param string $warning The occured warning
81 * @param string $propertyName The name of the property which caused the error
82 */
83 public function addWarning($warning, $propertyName) {
84 $this->warnings[$propertyName] = $warning;
85 }
86
87 /**
88 * Returns all warnings that occured so far
89 *
90 * @return array Array of warnings
91 */
92 public function getWarnings() {
93 return $this->warnings;
94 }
95
96 /**
97 * Returns TRUE if any warning was recognized
98 *
99 * @return boolean TRUE if a warning occured
100 */
101 public function hasWarnings() {
102 return count($this->warnings) > 0;
103 }
104
105 }
106
107
108 ?>