Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 10 |
|
0.00% |
0 / 7 |
CRAP | |
0.00% |
0 / 1 |
| ItemPacker | |
0.00% |
0 / 10 |
|
0.00% |
0 / 7 |
56 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| packItem | n/a |
0 / 0 |
n/a |
0 / 0 |
0 | |||||
| getPath | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getAssetEncoders | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| setAssetEncoders | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| isNestedResourcesInclusion | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| setNestedResourcesInclusion | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| setSkipValidation | |
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 (under the project TAO-PRODUCT); |
| 19 | * |
| 20 | * |
| 21 | */ |
| 22 | |
| 23 | namespace oat\taoItems\model\pack; |
| 24 | |
| 25 | use core_kernel_classes_Resource; |
| 26 | use common_Exception; |
| 27 | use oat\oatbox\filesystem\Directory; |
| 28 | |
| 29 | /** |
| 30 | * To allow packing of Item. The goal of the packaging is to represent the data needed |
| 31 | * to run an item (ie. an ItemPack). |
| 32 | * |
| 33 | * @package taoItems |
| 34 | */ |
| 35 | abstract class ItemPacker |
| 36 | { |
| 37 | /** |
| 38 | * Determines what type of assets should be packed as well as packer |
| 39 | * @example array('css'=>'base64') |
| 40 | * @var array |
| 41 | */ |
| 42 | protected $assetEncoders = [ 'js' => 'none', |
| 43 | 'css' => 'none', |
| 44 | 'font' => 'none', |
| 45 | 'img' => 'none', |
| 46 | 'audio' => 'none', |
| 47 | 'video' => 'none']; |
| 48 | |
| 49 | protected $nestedResourcesInclusion; |
| 50 | |
| 51 | /** @var bool */ |
| 52 | protected $skipValidation; |
| 53 | |
| 54 | public function __construct($assetEncoders = [], $nestedResourcesInclusion = true, bool $skipValidation = false) |
| 55 | { |
| 56 | $this->assetEncoders = array_merge($this->assetEncoders, $assetEncoders); |
| 57 | $this->nestedResourcesInclusion = $nestedResourcesInclusion; |
| 58 | $this->skipValidation = $skipValidation; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Create a pack for an item. |
| 63 | * |
| 64 | * @param core_kernel_classes_Resource $item the item to pack |
| 65 | * @param string $lang |
| 66 | * @param Directory $directory |
| 67 | * @return \oat\taoItems\model\pack\ItemPack |
| 68 | */ |
| 69 | abstract public function packItem(core_kernel_classes_Resource $item, $lang, Directory $directory); |
| 70 | |
| 71 | |
| 72 | /** |
| 73 | * @deprecated by fly-authoring |
| 74 | * |
| 75 | * @param core_kernel_classes_Resource $item |
| 76 | * @param $lang |
| 77 | * @return string |
| 78 | * @throws common_Exception |
| 79 | */ |
| 80 | protected function getPath(core_kernel_classes_Resource $item, $lang = "") |
| 81 | { |
| 82 | throw new \BadMethodCallException(__CLASS__ . ' - ' . __METHOD__ . ' disable by fly-authoring'); |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * @return array |
| 87 | */ |
| 88 | protected function getAssetEncoders() |
| 89 | { |
| 90 | return $this->assetEncoders; |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * @param array $assetEncoders |
| 95 | */ |
| 96 | public function setAssetEncoders(array $assetEncoders) |
| 97 | { |
| 98 | $this->assetEncoders = $assetEncoders; |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * @return boolean |
| 103 | */ |
| 104 | public function isNestedResourcesInclusion() |
| 105 | { |
| 106 | return $this->nestedResourcesInclusion; |
| 107 | } |
| 108 | |
| 109 | /** |
| 110 | * @param boolean $nestedResourcesInclusion |
| 111 | */ |
| 112 | public function setNestedResourcesInclusion($nestedResourcesInclusion) |
| 113 | { |
| 114 | $this->nestedResourcesInclusion = $nestedResourcesInclusion; |
| 115 | } |
| 116 | |
| 117 | public function setSkipValidation(bool $skipValidation): void |
| 118 | { |
| 119 | $this->skipValidation = $skipValidation; |
| 120 | } |
| 121 | } |