Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
77.78% |
28 / 36 |
|
50.00% |
6 / 12 |
CRAP | |
0.00% |
0 / 1 |
| DependsOnPropertyValidator | |
77.78% |
28 / 36 |
|
50.00% |
6 / 12 |
17.47 | |
0.00% |
0 / 1 |
| __construct | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 | |||
| isPreValidationRequired | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| getName | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getOptions | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| setOptions | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| getMessage | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| setMessage | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| evaluate | |
100.00% |
7 / 7 |
|
100.00% |
1 / 1 |
2 | |||
| setElement | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| acknowledge | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| getInvalidValues | |
90.91% |
10 / 11 |
|
0.00% |
0 / 1 |
3.01 | |||
| createContext | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
1 | |||
| 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) 2021 (original work) Open Assessment Technologies SA; |
| 19 | */ |
| 20 | |
| 21 | declare(strict_types=1); |
| 22 | |
| 23 | namespace oat\tao\model\Lists\Business\Validation; |
| 24 | |
| 25 | use tao_helpers_form_Form; |
| 26 | use tao_helpers_form_FormElement; |
| 27 | use oat\generis\model\data\Ontology; |
| 28 | use oat\oatbox\validator\ValidatorInterface; |
| 29 | use oat\tao\helpers\form\elements\FormElementAware; |
| 30 | use oat\tao\helpers\form\Decorator\ElementDecorator; |
| 31 | use oat\tao\helpers\form\validators\CrossElementEvaluationAware; |
| 32 | use oat\tao\helpers\form\validators\PreliminaryValidationInterface; |
| 33 | use oat\tao\model\Lists\Business\Domain\DependencyRepositoryContext; |
| 34 | use oat\tao\model\Lists\Business\Contract\DependencyRepositoryInterface; |
| 35 | |
| 36 | class DependsOnPropertyValidator implements |
| 37 | ValidatorInterface, |
| 38 | FormElementAware, |
| 39 | CrossElementEvaluationAware, |
| 40 | PreliminaryValidationInterface |
| 41 | { |
| 42 | /** @var DependencyRepositoryInterface */ |
| 43 | private $dependencyRepository; |
| 44 | |
| 45 | /** @var Ontology */ |
| 46 | private $ontology; |
| 47 | |
| 48 | /** @var array */ |
| 49 | private $options = []; |
| 50 | |
| 51 | /** @var string */ |
| 52 | private $message; |
| 53 | |
| 54 | /** @var tao_helpers_form_FormElement */ |
| 55 | private $element; |
| 56 | |
| 57 | /** @var ElementDecorator */ |
| 58 | private $elementDecorator; |
| 59 | |
| 60 | public function __construct(DependencyRepositoryInterface $dependencyRepository, Ontology $ontology) |
| 61 | { |
| 62 | $this->dependencyRepository = $dependencyRepository; |
| 63 | $this->ontology = $ontology; |
| 64 | } |
| 65 | |
| 66 | public function isPreValidationRequired(): bool |
| 67 | { |
| 68 | return true; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * {@inheritdoc} |
| 73 | */ |
| 74 | public function getName() |
| 75 | { |
| 76 | return self::class; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * {@inheritdoc} |
| 81 | */ |
| 82 | public function getOptions() |
| 83 | { |
| 84 | return $this->options; |
| 85 | } |
| 86 | |
| 87 | /** |
| 88 | * {@inheritdoc} |
| 89 | */ |
| 90 | public function setOptions(array $options) |
| 91 | { |
| 92 | $this->options = $options; |
| 93 | |
| 94 | return $this; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * {@inheritdoc} |
| 99 | */ |
| 100 | public function getMessage() |
| 101 | { |
| 102 | return $this->message; |
| 103 | } |
| 104 | |
| 105 | /** |
| 106 | * {@inheritdoc} |
| 107 | */ |
| 108 | public function setMessage($message) |
| 109 | { |
| 110 | $this->message = $message; |
| 111 | |
| 112 | return $this; |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * @return bool |
| 117 | */ |
| 118 | public function evaluate($values) |
| 119 | { |
| 120 | $providedValues = $this->elementDecorator->getListValues(); |
| 121 | $invalidValues = $this->getInvalidValues($providedValues); |
| 122 | $isValid = empty($invalidValues); |
| 123 | |
| 124 | if (!$isValid) { |
| 125 | $this->element->setInvalidValues($invalidValues); |
| 126 | $this->message = __('The selected value(s) must be compatible with the primary property.'); |
| 127 | } |
| 128 | |
| 129 | return $isValid; |
| 130 | } |
| 131 | |
| 132 | public function setElement(tao_helpers_form_FormElement $element): void |
| 133 | { |
| 134 | $this->element = $element; |
| 135 | } |
| 136 | |
| 137 | public function acknowledge(tao_helpers_form_Form $form): void |
| 138 | { |
| 139 | $this->elementDecorator = new ElementDecorator($this->ontology, $form, $this->element); |
| 140 | } |
| 141 | |
| 142 | private function getInvalidValues(array $providedValues): array |
| 143 | { |
| 144 | $validValues = []; |
| 145 | |
| 146 | foreach ($this->elementDecorator->getPrimaryElementsDecorators() as $elementDecorator) { |
| 147 | if (empty($elementDecorator->getListValues())) { |
| 148 | continue; |
| 149 | } |
| 150 | |
| 151 | $context = $this->createContext( |
| 152 | $elementDecorator->getRangeClass()->getUri(), |
| 153 | $elementDecorator->getListValues() |
| 154 | ); |
| 155 | $childListItemsUris = $this->dependencyRepository->findChildListItemsUris($context); |
| 156 | |
| 157 | $validValues = array_merge($validValues, array_intersect($providedValues, $childListItemsUris)); |
| 158 | } |
| 159 | |
| 160 | return array_diff($providedValues, $validValues); |
| 161 | } |
| 162 | |
| 163 | private function createContext(string $rangeUri, array $listValues): DependencyRepositoryContext |
| 164 | { |
| 165 | return new DependencyRepositoryContext( |
| 166 | [ |
| 167 | DependencyRepositoryContext::PARAM_LIST_URIS => [$rangeUri], |
| 168 | DependencyRepositoryContext::PARAM_DEPENDENCY_LIST_VALUES => $listValues, |
| 169 | ] |
| 170 | ); |
| 171 | } |
| 172 | } |