Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 7 |
|
0.00% |
0 / 4 |
CRAP | |
0.00% |
0 / 1 |
| ValidationException | |
0.00% |
0 / 7 |
|
0.00% |
0 / 4 |
20 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| getProperty | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getValue | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getUserMessage | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2015 (original work) Open Assessment Technologies SA |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\tao\helpers\data; |
| 23 | |
| 24 | /** |
| 25 | * Validation during preprocessing of a value that should be |
| 26 | * assigned to a given property |
| 27 | * |
| 28 | * @access public |
| 29 | * @author Joel Bout, <joel@taotesting.com> |
| 30 | * @package tao |
| 31 | */ |
| 32 | class ValidationException extends \Exception implements \common_exception_UserReadableException |
| 33 | { |
| 34 | /** |
| 35 | * @param \core_kernel_classes_Property $property |
| 36 | */ |
| 37 | private $property; |
| 38 | |
| 39 | /** |
| 40 | * @var mixed |
| 41 | */ |
| 42 | private $value; |
| 43 | |
| 44 | /** |
| 45 | * Message that is save to display to user |
| 46 | * |
| 47 | * @var string |
| 48 | */ |
| 49 | private $userMessage; |
| 50 | |
| 51 | /** |
| 52 | * |
| 53 | * @param \core_kernel_classes_Property $property |
| 54 | * @param mixed $value |
| 55 | * @param string $userMessage |
| 56 | */ |
| 57 | public function __construct(\core_kernel_classes_Property $property, $value, $userMessage) |
| 58 | { |
| 59 | parent::__construct($userMessage . ' ' . $property->getUri() . ' ' . $value); |
| 60 | $this->property = $property; |
| 61 | $this->value = $value; |
| 62 | $this->userMessage = $userMessage; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Returns the property the value should be assigned to |
| 67 | * |
| 68 | * @return core_kernel_classes_Property |
| 69 | */ |
| 70 | public function getProperty() |
| 71 | { |
| 72 | return $this->property; |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Returns the value that failed validation |
| 77 | * |
| 78 | * @return mixed |
| 79 | */ |
| 80 | public function getValue() |
| 81 | { |
| 82 | return $this->value; |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * (non-PHPdoc) |
| 87 | * @see common_exception_UserReadableException::getUserMessage() |
| 88 | */ |
| 89 | public function getUserMessage() |
| 90 | { |
| 91 | return $this->userMessage; |
| 92 | } |
| 93 | } |