class.ilTestExportPlugin.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Component/classes/class.ilPlugin.php';
require_once 'Modules/Test/classes/class.ilTestExportFilename.php';

abstract class ilTestExportPlugin extends ilPlugin
{
        protected $test;

        protected $timestmap = -1;
        
        protected static $reserved_formats = array(
                'xml',
                'csv'
        );
        
        final public function getComponentType()
        {
                return IL_COMP_MODULE;
        }

        final public function getComponentName()
        {
                return "Test";
        }

        final public function getSlot()
        {
                return "Export";
        }

        final public function getSlotId()
        {
                return "texp";
        }

        final protected function slotInit()
        {
        }

        final public function setTest($test)
        {
                $this->test = $test;
        }

        final protected function getTest()
        {
                return $this->test;
        }

        public function setTimestmap($timestmap)
        {
                $this->timestmap = $timestmap;
        }

        public function getTimestmap()
        {
                return $this->timestmap;
        }
        
        final public function getFormat()
        {
                $format_id = $this->getFormatIdentifier();

                if(!is_string($format_id))
                {
                        throw new ilException('The format must be of type string.');
                }

                if(!strlen($format_id))
                {
                        throw new ilException('The format is empty.');
                }

                if(strtolower($format_id) != $format_id)
                {
                        throw new ilException('Please use a lowercase format.');
                }

                if(in_array($format_id, self::$reserved_formats))
                {
                        throw new ilException('The format must not be one of: ' . implode(', ', self::$reserved_formats));
                }

                return $format_id;
        }

        final public function export()
        {
                global $lng, $ilCtrl;

                if(!$this->getTest() instanceof ilObjTest)
                {
                        throw new ilException('Incomplete object configuration. Please pass an instance of ilObjTest before calling the export!');
                }

                try
                {
                        $this->buildExportFile(new ilTestExportFilename($this->getTest()));
                }
                catch(ilException $e)
                {
                        if($this->txt($e->getMessage()) == '-' . $e->getMessage() . '-')
                        {
                                ilUtil::sendFailure($e->getMessage(), true);
                        }
                        else
                        {
                                ilUtil::sendFailure($this->txt($e->getMessage()), true);
                        }
                        $ilCtrl->redirectByClass('iltestexportgui');
                }

                ilUtil::sendSuccess($lng->txt('exp_file_created'), true);
                $ilCtrl->redirectByClass('iltestexportgui');
        }

        abstract protected function buildExportFile(ilTestExportFilename $export_path);

        abstract protected function getFormatIdentifier();

        abstract public function getFormatLabel();
}