Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 76 |
|
0.00% |
0 / 6 |
CRAP | |
0.00% |
0 / 1 |
| OatPciExporter | |
0.00% |
0 / 76 |
|
0.00% |
0 / 6 |
380 | |
0.00% |
0 / 1 |
| copyAssetFiles | |
0.00% |
0 / 17 |
|
0.00% |
0 / 1 |
12 | |||
| getNodeName | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getTypeIdentifierAttributeName | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getXmlnsName | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| exportDom | |
0.00% |
0 / 54 |
|
0.00% |
0 / 1 |
156 | |||
| getOatPciExportPath | |
0.00% |
0 / 2 |
|
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) 2017 (original work) Open Assessment Technologies SA; |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\qtiItemPci\model\portableElement\export; |
| 23 | |
| 24 | use oat\oatbox\service\ServiceManager; |
| 25 | use oat\taoQtiItem\model\portableElement\PortableElementService; |
| 26 | use oat\taoQtiItem\model\portableElement\export\PortableElementExporter; |
| 27 | use oat\taoQtiItem\model\portableElement\element\PortableElementObject; |
| 28 | use DOMDocument; |
| 29 | use DOMXPath; |
| 30 | |
| 31 | class OatPciExporter extends PortableElementExporter |
| 32 | { |
| 33 | /** |
| 34 | * Copy the asset files of the PCI to the item exporter and return the list of copied assets |
| 35 | * @param $replacementList |
| 36 | * @return array |
| 37 | * @throws \oat\taoQtiItem\model\portableElement\exception\PortableElementInvalidAssetException |
| 38 | */ |
| 39 | public function copyAssetFiles(&$replacementList) |
| 40 | { |
| 41 | $object = $this->object; |
| 42 | $portableAssetsToExport = []; |
| 43 | $service = new PortableElementService(); |
| 44 | $service->setServiceLocator(ServiceManager::getServiceManager()); |
| 45 | $files = $object->getModel()->getValidator()->getAssets($object, 'runtime'); |
| 46 | $baseUrl = $this->qtiItemExporter->buildBasePath() . DIRECTORY_SEPARATOR . $object->getTypeIdentifier(); |
| 47 | foreach ($files as $url) { |
| 48 | // Skip shared libraries into portable element |
| 49 | if (strpos($url, './') !== 0) { |
| 50 | \common_Logger::i('Shared libraries skipped : ' . $url); |
| 51 | $portableAssetsToExport[$url] = $url; |
| 52 | continue; |
| 53 | } |
| 54 | $stream = $service->getFileStream($object, $url); |
| 55 | $replacement = $this->qtiItemExporter->copyAssetFile($stream, $baseUrl, $url, $replacementList); |
| 56 | $portableAssetToExport = preg_replace('/^(.\/)(.*)/', $object->getTypeIdentifier() . "/$2", $replacement); |
| 57 | $portableAssetsToExport[$url] = $portableAssetToExport; |
| 58 | \common_Logger::i('File copied: "' . $url . '" for portable element ' . $object->getTypeIdentifier()); |
| 59 | } |
| 60 | return $this->portableAssetsToExport = $portableAssetsToExport; |
| 61 | } |
| 62 | |
| 63 | public function getNodeName() |
| 64 | { |
| 65 | return 'portableCustomInteraction'; |
| 66 | } |
| 67 | |
| 68 | public function getTypeIdentifierAttributeName() |
| 69 | { |
| 70 | return 'customInteractionTypeIdentifier'; |
| 71 | } |
| 72 | |
| 73 | public function getXmlnsName() |
| 74 | { |
| 75 | return 'pci'; |
| 76 | } |
| 77 | |
| 78 | public function exportDom(DOMDocument $dom) |
| 79 | { |
| 80 | |
| 81 | // If asset files list is empty for current identifier skip |
| 82 | if (empty($this->portableAssetsToExport)) { |
| 83 | return; |
| 84 | } |
| 85 | |
| 86 | $xpath = new DOMXPath($dom); |
| 87 | |
| 88 | // Get all portable element from qti.xml |
| 89 | $portableElementNodes = $dom->getElementsByTagName($this->getNodeName()); |
| 90 | |
| 91 | /** @var PortableElementObject $portableElement */ |
| 92 | $portableElement = $this->object; |
| 93 | |
| 94 | for ($i = 0; $i < $portableElementNodes->length; $i++) { |
| 95 | |
| 96 | /** @var \DOMElement $currentPortableNode */ |
| 97 | $currentPortableNode = $portableElementNodes->item($i); |
| 98 | |
| 99 | //get the local namespace prefix to be used in new node creation |
| 100 | $localNs = $currentPortableNode->hasAttribute('xmlns') ? '' : $this->getXmlnsName() . ':'; |
| 101 | |
| 102 | //get the portable element type identifier |
| 103 | $identifier = $currentPortableNode->getAttribute($this->getTypeIdentifierAttributeName()); |
| 104 | |
| 105 | if ($identifier != $portableElement->getTypeIdentifier()) { |
| 106 | continue; |
| 107 | } |
| 108 | |
| 109 | // Add hook and version as attributes |
| 110 | if ($portableElement->hasRuntimeKey('hook')) { |
| 111 | $currentPortableNode->setAttribute( |
| 112 | 'hook', |
| 113 | preg_replace( |
| 114 | '/^(.\/)(.*)/', |
| 115 | $portableElement->getTypeIdentifier() . "/$2", |
| 116 | $portableElement->getRuntimeKey('hook') |
| 117 | ) |
| 118 | ); |
| 119 | } |
| 120 | |
| 121 | //set version |
| 122 | $currentPortableNode->setAttribute('version', $portableElement->getVersion()); |
| 123 | |
| 124 | /** @var \DOMElement $resourcesNode */ |
| 125 | $resourcesNode = $currentPortableNode->getElementsByTagName('resources')->item(0); |
| 126 | |
| 127 | $this->removeOldNode($resourcesNode, 'libraries'); |
| 128 | $this->removeOldNode($resourcesNode, 'stylesheets'); |
| 129 | $this->removeOldNode($resourcesNode, 'mediaFiles'); |
| 130 | |
| 131 | // Portable libraries |
| 132 | $librariesNode = $dom->createElement($localNs . 'libraries'); |
| 133 | foreach ($portableElement->getRuntimeKey('libraries') as $library) { |
| 134 | $libraryNode = $dom->createElement($localNs . 'lib'); |
| 135 | //the exported lib id must be adapted from a href mode to an amd name mode |
| 136 | $libraryNode->setAttribute('id', preg_replace('/\.js$/', '', $this->getOatPciExportPath($library))); |
| 137 | $librariesNode->appendChild($libraryNode); |
| 138 | } |
| 139 | if ($librariesNode->hasChildNodes()) { |
| 140 | $resourcesNode->appendChild($librariesNode); |
| 141 | } |
| 142 | |
| 143 | // Portable stylesheets |
| 144 | $stylesheetsNode = $dom->createElement($localNs . 'stylesheets'); |
| 145 | foreach ($portableElement->getRuntimeKey('stylesheets') as $stylesheet) { |
| 146 | $stylesheetNode = $dom->createElement($localNs . 'link'); |
| 147 | $stylesheetNode->setAttribute('href', $this->getOatPciExportPath($stylesheet)); |
| 148 | $stylesheetNode->setAttribute('type', 'text/css'); |
| 149 | |
| 150 | $info = pathinfo($stylesheet); |
| 151 | $stylesheetNode->setAttribute('title', basename($stylesheet, '.' . $info['extension'])); |
| 152 | $stylesheetsNode->appendChild($stylesheetNode); |
| 153 | } |
| 154 | if ($stylesheetsNode->hasChildNodes()) { |
| 155 | $resourcesNode->appendChild($stylesheetsNode); |
| 156 | } |
| 157 | |
| 158 | // Portable mediaFiles |
| 159 | $mediaFilesNode = $dom->createElement($localNs . 'mediaFiles'); |
| 160 | foreach ($portableElement->getRuntimeKey('mediaFiles') as $mediaFile) { |
| 161 | $mediaFileNode = $dom->createElement($localNs . 'file'); |
| 162 | $mediaFileNode->setAttribute('src', $this->getOatPciExportPath($mediaFile)); |
| 163 | $mediaFileNode->setAttribute( |
| 164 | 'type', |
| 165 | \tao_helpers_File::getMimeType($this->getOatPciExportPath($mediaFile)) |
| 166 | ); |
| 167 | $mediaFilesNode->appendChild($mediaFileNode); |
| 168 | } |
| 169 | if ($mediaFilesNode->hasChildNodes()) { |
| 170 | $resourcesNode->appendChild($mediaFilesNode); |
| 171 | } |
| 172 | } |
| 173 | |
| 174 | unset($xpath); |
| 175 | } |
| 176 | |
| 177 | private function getOatPciExportPath($file) |
| 178 | { |
| 179 | $key = preg_replace('/^' . $this->object->getTypeIdentifier() . '\//', './', $file); |
| 180 | |
| 181 | return $this->portableAssetsToExport[$key]; |
| 182 | } |
| 183 | } |