Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
|||
| 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) 2014 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\taoQtiItem\model\qti\metadata; |
| 23 | |
| 24 | /** |
| 25 | * A MetadataInjector implements the mechanics to inject all metadata values from a given list of MetadataValue objects |
| 26 | * into a given target. |
| 27 | * |
| 28 | * A MetadataInjection implementation could inject MetadataValue objects in various kind of sources, such |
| 29 | * as IMS Manifest XML Files, Ontologies, QTI Items, QTI Tests, ... |
| 30 | * |
| 31 | * @author Jérôme Bogaerts <jerome@taotesting.com> |
| 32 | * @see MetadataValue The MedataValue interface, describing metadata values to be injected into a given target. |
| 33 | */ |
| 34 | interface MetadataInjector |
| 35 | { |
| 36 | /** |
| 37 | * Inject a set of metadata values into a given $target. |
| 38 | * |
| 39 | * Please see the documentation of the MetadataValue interface for in depth information |
| 40 | * about what a metadata value actually is. |
| 41 | * |
| 42 | * It is the responsibility of the implementation to throw an exception if the datatype of the $target |
| 43 | * argument is not suitable. |
| 44 | * |
| 45 | * @param mixed $target The target where you want to inject some metadata values. |
| 46 | * @param MetadataValue[] $values The metadata values to be injected. |
| 47 | * @throws MetadataInjectionException If something goes wrong during the injection process. |
| 48 | */ |
| 49 | public function inject($target, array $values); |
| 50 | } |