class.ilTestExportPlugin.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Test\ExportImport\Exporter;
use ILIAS\Test\ExportImport\ExportFilename;

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

    protected static $reserved_formats = [
        'xml',
        'csv'
    ];

    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 deliver(): void
    {
        global $DIC;
        $main_tpl = $DIC['tpl'];
        $file_delivery = $DIC['file_delivery'];

        if (($file_name = $this->createExportFile($main_tpl)) === null) {
            return;
        }

        $this->file_delivery->legacyDelivery()->attached(
            $file_name,
            null,
            null,
            true
        );
        $file_delivery->deliver();
    }

    final public function write(): ?string
    {
        return $this->createExportFile();
    }

    private function createExportFile(ilGlobalTemplateInterface $main_tpl): ?string
    {
        if ($this->getTest() === null) {
            throw new ilException('Incomplete object configuration. Please pass an instance of ilObjTest before calling the export!');
        }

        try {
            $export_filename = new ExportFilename($this->getTest()->getId());
            $this->buildExportFile($export_filename);
            return $export_filename->getPathname();
        } catch (ilException $e) {
            if ($this->txt($e->getMessage()) == '-' . $e->getMessage() . '-') {
                $main_tpl->setOnScreenMessage('failure', $e->getMessage(), true);
            } else {
                $main_tpl->setOnScreenMessage('failure', $this->txt($e->getMessage()), true);
            }
            return null;
        }
    }

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

    abstract protected function getFormatIdentifier(): string;

    abstract public function getFormatLabel(): string;
}