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) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg |
| 19 | * (under the project TAO & TAO2); |
| 20 | * 2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung |
| 21 | * (under the project TAO-TRANSFER); |
| 22 | * 2009-2012 (update and modification) Public Research Centre Henri Tudor |
| 23 | * (under the project TAO-SUSTAIN & TAO-DEV); |
| 24 | * |
| 25 | */ |
| 26 | |
| 27 | /** |
| 28 | * A class that handles everythign around the exportation of |
| 29 | * several resources into a single file |
| 30 | * |
| 31 | * @access public |
| 32 | * @author Joel Bout, <joel@taotesting.com> |
| 33 | * @package tao |
| 34 | |
| 35 | */ |
| 36 | interface tao_models_classes_export_ExportHandler |
| 37 | { |
| 38 | /** |
| 39 | * Returns a textual description of the export format |
| 40 | * |
| 41 | * @return string |
| 42 | */ |
| 43 | public function getLabel(); |
| 44 | |
| 45 | /** |
| 46 | * Returns a form in order to prepare the |
| 47 | * |
| 48 | * @param core_kernel_classes_Resource $resource the users selected resource or class |
| 49 | * @return tao_helpers_form_Form |
| 50 | */ |
| 51 | public function getExportForm(core_kernel_classes_Resource $resource); |
| 52 | |
| 53 | /** |
| 54 | * Export the resources to a file stored in $destinations |
| 55 | * |
| 56 | * @param array $formValues the values returned by the form provided by getForm |
| 57 | * @param string $destPath path to export the resources to |
| 58 | * @return common_report_Report report or string filepath |
| 59 | * @throws common_exception_UserReadableException $exception |
| 60 | */ |
| 61 | public function export($formValues, $destPath); |
| 62 | } |