Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 91 |
|
0.00% |
0 / 6 |
CRAP | |
0.00% |
0 / 1 |
| tao_actions_form_Instance | |
0.00% |
0 / 91 |
|
0.00% |
0 / 6 |
1260 | |
0.00% |
0 / 1 |
| initForm | |
0.00% |
0 / 11 |
|
0.00% |
0 / 1 |
12 | |||
| initElements | |
0.00% |
0 / 75 |
|
0.00% |
0 / 1 |
756 | |||
| getElementFactory | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getServiceLocator | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getFormDataProvider | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| isEmptyLabel | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
6 | |||
| 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) 2008-2010 (original work) Deutsche Institut für Internationale Pädagogische Forschung |
| 19 | * (under the project TAO-TRANSFER); |
| 20 | * 2009-2012 (update and modification) Public Research Centre Henri Tudor |
| 21 | * (under the project TAO-SUSTAIN & TAO-DEV); |
| 22 | * 2017-2021 (update and modification) Open Assessment Technologies SA; |
| 23 | */ |
| 24 | |
| 25 | use oat\generis\model\OntologyAwareTrait; |
| 26 | use oat\generis\model\OntologyRdfs; |
| 27 | use oat\oatbox\service\ServiceManager; |
| 28 | use oat\tao\helpers\form\ElementMapFactory; |
| 29 | use oat\tao\helpers\form\elements\ElementValue; |
| 30 | use oat\tao\model\form\DataProvider\FormDataProviderInterface; |
| 31 | use oat\tao\model\form\DataProvider\ProxyFormDataProvider; |
| 32 | use Zend\ServiceManager\ServiceLocatorInterface; |
| 33 | |
| 34 | /** |
| 35 | * Create a form from a resource of your ontology. |
| 36 | * Each property will be a field, regarding it's widget. |
| 37 | * |
| 38 | * @access public |
| 39 | * @author Bertrand Chevrier, <bertrand.chevrier@tudor.lu> |
| 40 | * @package tao |
| 41 | */ |
| 42 | class tao_actions_form_Instance extends tao_actions_form_Generis |
| 43 | { |
| 44 | use OntologyAwareTrait; |
| 45 | |
| 46 | public const EXCLUDED_PROPERTIES = 'excludedProperties'; |
| 47 | /** |
| 48 | * Initialize the form |
| 49 | * |
| 50 | * @author Bertrand Chevrier, <bertrand.chevrier@tudor.lu> |
| 51 | * |
| 52 | * @throws common_Exception |
| 53 | */ |
| 54 | protected function initForm() |
| 55 | { |
| 56 | $name = isset($this->options['name']) ? $this->options['name'] : ''; |
| 57 | if (empty($name)) { |
| 58 | $name = 'form_' . (count(self::$forms) + 1); |
| 59 | } |
| 60 | unset($this->options['name']); |
| 61 | |
| 62 | $this->form = tao_helpers_form_FormFactory::getForm($name, $this->options); |
| 63 | |
| 64 | //add translate action in toolbar |
| 65 | $actions = tao_helpers_form_FormFactory::getCommonActions(); |
| 66 | |
| 67 | //add a hidden form element that states that it is an Instance Form. |
| 68 | $instanceElt = tao_helpers_form_FormFactory::getElement('tao.forms.instance', 'Hidden'); |
| 69 | $instanceElt->setValue('1'); |
| 70 | $this->form->addElement($instanceElt, true); |
| 71 | |
| 72 | $this->form->setActions($actions, 'top'); |
| 73 | $this->form->setActions($actions, 'bottom'); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Initialize the form elements |
| 78 | * |
| 79 | * @access protected |
| 80 | * @author Bertrand Chevrier, <bertrand.chevrier@tudor.lu> |
| 81 | */ |
| 82 | protected function initElements() |
| 83 | { |
| 84 | $class = $this->getClazz(); |
| 85 | $instance = $this->getInstance(); |
| 86 | |
| 87 | // Guess language |
| 88 | try { |
| 89 | $language = $this->options['lang'] ?? common_session_SessionManager::getSession()->getInterfaceLanguage(); |
| 90 | } catch (common_exception_Error $exception) { |
| 91 | $language = DEFAULT_LANG; |
| 92 | } |
| 93 | |
| 94 | $topClass = $this->getTopClazz(); |
| 95 | |
| 96 | if ($instance) { |
| 97 | $this->getFormDataProvider()->preloadFormData( |
| 98 | $class->getUri(), |
| 99 | $topClass->getUri(), |
| 100 | $instance->getUri(), |
| 101 | $language |
| 102 | ); |
| 103 | } |
| 104 | |
| 105 | //get the list of properties to set in the form |
| 106 | $propertyCandidates = tao_helpers_form_GenerisFormFactory::getDefaultProperties(); |
| 107 | $classProperties = $this->getFormDataProvider()->getClassProperties($class, $topClass); |
| 108 | |
| 109 | $propertyCandidates = array_merge($propertyCandidates, $classProperties); |
| 110 | |
| 111 | $additionalProperties = (isset($this->options['additionalProperties']) |
| 112 | && is_array($this->options['additionalProperties'])) |
| 113 | ? $this->options['additionalProperties'] |
| 114 | : []; |
| 115 | if (!empty($additionalProperties)) { |
| 116 | $propertyCandidates = array_merge($propertyCandidates, $additionalProperties); |
| 117 | } |
| 118 | |
| 119 | $excludedProperties = (isset($this->options[self::EXCLUDED_PROPERTIES]) |
| 120 | && is_array($this->options[self::EXCLUDED_PROPERTIES])) |
| 121 | ? $this->options[self::EXCLUDED_PROPERTIES] |
| 122 | : []; |
| 123 | $editedProperties = []; |
| 124 | foreach ($propertyCandidates as $property) { |
| 125 | if (!isset($editedProperties[$property->getUri()]) && !in_array($property->getUri(), $excludedProperties)) { |
| 126 | $editedProperties[$property->getUri()] = $property; |
| 127 | } |
| 128 | } |
| 129 | |
| 130 | $finalElements = []; |
| 131 | foreach ($editedProperties as $property) { |
| 132 | $property->feedFromData(...$this->getFormDataProvider()->getDataToFeedProperty($property)); |
| 133 | |
| 134 | $widget = $property->getWidget(); |
| 135 | if ($widget === null || $widget instanceof core_kernel_classes_Literal) { |
| 136 | continue; |
| 137 | } |
| 138 | |
| 139 | //map properties widgets to form elements |
| 140 | $elementFactory = $this->getElementFactory(); |
| 141 | |
| 142 | if ($instance instanceof core_kernel_classes_Resource) { |
| 143 | $elementFactory->withInstance($instance); |
| 144 | } |
| 145 | |
| 146 | $element = $elementFactory->create($property, $language); |
| 147 | |
| 148 | if ($element !== null) { |
| 149 | if ($instance) { |
| 150 | $propertyInstanceValues = $this |
| 151 | ->getFormDataProvider() |
| 152 | ->getPropertyInstanceValues($property, $instance, $element); |
| 153 | foreach ($propertyInstanceValues as $valueData) { |
| 154 | if ($this->getFormDataProvider()->isPropertyList($property)) { |
| 155 | $element->setValue( |
| 156 | new ElementValue(tao_helpers_Uri::encode($valueData[0]), $valueData[1]) |
| 157 | ); |
| 158 | } else { |
| 159 | $element->setValue($valueData[0]); |
| 160 | } |
| 161 | } |
| 162 | } |
| 163 | |
| 164 | if ($this->isEmptyLabel($element)) { |
| 165 | continue; |
| 166 | } |
| 167 | |
| 168 | if ($property->getUri() === OntologyRdfs::RDFS_LABEL) { |
| 169 | // Label will not be a TAO Property. However, it should be always first. |
| 170 | array_splice($finalElements, 0, 0, [[$element, 1]]); |
| 171 | } elseif (count($guiOrder = $this->getFormDataProvider()->getPropertyGUIOrder($property))) { |
| 172 | // get position of this property if it has one. |
| 173 | $position = (int) $guiOrder[0]; |
| 174 | |
| 175 | // insert the element at the right place. |
| 176 | $i = 0; |
| 177 | while ( |
| 178 | $i < count($finalElements) |
| 179 | && ($position >= $finalElements[$i][1] && $finalElements[$i][1] !== null) |
| 180 | ) { |
| 181 | $i++; |
| 182 | } |
| 183 | |
| 184 | array_splice($finalElements, $i, 0, [[$element, $position]]); |
| 185 | } else { |
| 186 | // Unordered properties will go at the end of the form. |
| 187 | $finalElements[] = [$element, null]; |
| 188 | } |
| 189 | } |
| 190 | } |
| 191 | |
| 192 | // Add elements related to class properties to the form. |
| 193 | foreach ($finalElements as $element) { |
| 194 | $this->form->addElement($element[0]); |
| 195 | } |
| 196 | |
| 197 | //add a hidden elt for the class uri |
| 198 | $classUriElt = tao_helpers_form_FormFactory::getElement('classUri', 'Hidden'); |
| 199 | $classUriElt->setValue(tao_helpers_Uri::encode($class->getUri())); |
| 200 | $this->form->addElement($classUriElt, true); |
| 201 | |
| 202 | if ($instance) { |
| 203 | //add a hidden elt for the instance Uri |
| 204 | $instanceUriElt = tao_helpers_form_FormFactory::getElement('uri', 'Hidden'); |
| 205 | $instanceUriElt->setValue(tao_helpers_Uri::encode($instance->getUri())); |
| 206 | $this->form->addElement($instanceUriElt, true); |
| 207 | |
| 208 | $hiddenId = tao_helpers_form_FormFactory::getElement('id', 'Hidden'); |
| 209 | $hiddenId->setValue($instance->getUri()); |
| 210 | $this->form->addElement($hiddenId, true); |
| 211 | } |
| 212 | } |
| 213 | |
| 214 | private function getElementFactory(): ElementMapFactory |
| 215 | { |
| 216 | /** @noinspection PhpIncompatibleReturnTypeInspection */ |
| 217 | return $this->getServiceLocator()->get(ElementMapFactory::class); |
| 218 | } |
| 219 | |
| 220 | private function getServiceLocator(): ServiceLocatorInterface |
| 221 | { |
| 222 | return ServiceManager::getServiceManager(); |
| 223 | } |
| 224 | |
| 225 | private function getFormDataProvider(): FormDataProviderInterface |
| 226 | { |
| 227 | return $this->getServiceLocator()->getContainer()->get(ProxyFormDataProvider::class)->getProvider(); |
| 228 | } |
| 229 | |
| 230 | private function isEmptyLabel($element): bool |
| 231 | { |
| 232 | return $element instanceof tao_helpers_form_elements_Label |
| 233 | && empty($element->getRawValue()); |
| 234 | } |
| 235 | } |