class.ilTestExportPlugin.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilTestExportPlugin extends ilPlugin
{
    protected ilObjTest $test;
    protected int $timestmap = -1;

    protected static $reserved_formats = array(
        'xml',
        'csv'
    );
    private \ilGlobalTemplateInterface $main_tpl;

    public function __construct(
        \ilDBInterface $db,
        \ilComponentRepositoryWrite $component_repository,
        string $id
    ) {
        parent::__construct($db, $component_repository, $id);
    }

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

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

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

    public function getTimestmap(): int
    {
        return $this->timestmap;
    }

    final public function getFormat(): string
    {
        $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(): void
    {
        global $DIC;
        // these dependencies need to be fetched here because they are not available in constructor during ILIAS setup
        $tpl = $DIC->ui()->mainTemplate();
        $ctrl = $DIC->ctrl();
        $lng = $DIC->language();

        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() . '-') {
                $tpl->setOnScreenMessage('failure', $e->getMessage(), true);
            } else {
                $tpl->setOnScreenMessage('failure', $this->txt($e->getMessage()), true);
            }
            $ctrl->redirectByClass('iltestexportgui');
        }

        $tpl->setOnScreenMessage('success', $lng->txt('exp_file_created'), true);
        $ctrl->redirectByClass('iltestexportgui');
    }

    abstract protected function buildExportFile(ilTestExportFilename $export_path): void;

    abstract protected function getFormatIdentifier(): string;

    abstract public function getFormatLabel(): string;
}