ilTestExportGUI Class Reference

Export User Interface Class. More...

Inheritance diagram for ilTestExportGUI:

Collaboration diagram for ilTestExportGUI:

Public Member Functions
	__construct (ilObjTestGUI $parent_gui, private ilDBInterface $db, private ilLogger $logger, private ilObjectDataCache $obj_cache, private ilComponentRepository $component_repository, Generator $active_export_plugins, private ilTestHTMLGenerator $html_generator, private array $selected_files, private QuestionInfoService $questioninfo,)
	createTestExportWithResults ()
	Create test export file. More...
	createTestResultsExport ()
	createTestArchiveExport ()
	listExportFiles ()
	download ()
	delete ()
Public Member Functions inherited from ilExportGUI
	__construct (object $a_parent_gui, ?ilObject $a_main_obj=null)
	addFormat (string $a_key, string $a_txt="", object $a_call_obj=null, string $a_call_func="")
	getFormats ()
	addCustomColumn (string $a_txt, object $a_obj, string $a_func)
	addCustomMultiCommand (string $a_txt, object $a_obj, string $a_func)
	getCustomMultiCommands ()
	getCustomColumns ()
	executeCommand ()
	listExportFiles ()
	createExportFile ()
	confirmDeletion ()
	Confirm file deletion. More...
	delete ()
	download ()
	Download file. More...
	handleCustomMultiCommand ()

Protected Member Functions
	buildExportTableGUI ()
Protected Member Functions inherited from ilExportGUI
	initFileIdentifierFromQuery ()
	initFileIdentifiersFromPost ()
	initFormatFromPost ()
	initExportOptionsFromPost ()
	buildExportTableGUI ()
	getParentGUI ()
	showItemSelection ()
	Show container item selection table. More...
	saveItemSelection ()

Private Member Functions
	getExportTypeFromFileName (string $export_file)

Additional Inherited Members
Protected Attributes inherited from ilExportGUI
ILIAS Export InternalGUIService	$gui
Factory	$refinery
Services	$http
array	$formats = array()
array	$custom_columns = array()
array	$custom_multi_commands = array()
ilObject	$obj
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilCtrlInterface	$ctrl
ilAccessHandler	$access
ilErrorHandling	$error
ilToolbarGUI	$toolbar
ilObjectDefinition	$objDefinition
ilTree	$tree

Detailed Description

Export User Interface Class.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

ilTestExportGUI: ilParticipantsTestResultsGUI

Definition at line 35 of file class.ilTestExportGUI.php.

Constructor & Destructor Documentation

__construct()

ilTestExportGUI::__construct	(	ilObjTestGUI	$parent_gui,
		private ilDBInterface	$db,
		private ilLogger	$logger,
		private ilObjectDataCache	$obj_cache,
		private ilComponentRepository	$component_repository,
		Generator	$active_export_plugins,
		private ilTestHTMLGenerator	$html_generator,
		private array	$selected_files,
		private QuestionInfoService	$questioninfo
	)

Definition at line 37 of file class.ilTestExportGUI.php.

References XapiProxy\$plugin, ILIAS\MetaData\Repository\Validation\Data\__construct(), ilExportGUI\addFormat(), and ILIAS\Repository\lng().

      {
        parent::__construct($parent_gui, null);

        $this->addFormat('xml', $this->lng->txt('ass_create_export_file'));
        $this->addFormat('xmlres', $this->lng->txt('ass_create_export_file_with_results'), $this, 'createTestExportWithResults');
        $this->addFormat('csv', $this->lng->txt('ass_create_export_test_results'), $this, 'createTestResultsExport');
        $this->addFormat('arc', $this->lng->txt('ass_create_export_test_archive'), $this, 'createTestArchiveExport');
        foreach ($active_export_plugins as $plugin) {
            $plugin->setTest($this->obj);
            $this->addFormat(
                $plugin->getFormat(),
                $plugin->getFormatLabel(),
                $plugin,
                'export'
            );
        }
    }

Here is the call graph for this function:

Member Function Documentation

buildExportTableGUI()

ilTestExportGUI::buildExportTableGUI ( )

protected

Returns

ilTestExportTableGUI

Definition at line 68 of file class.ilTestExportGUI.php.

Referenced by listExportFiles().

                                            : ilTestExportTableGUI
    {
        $table = new ilTestExportTableGUI($this, 'listExportFiles', $this->obj);
        return $table;
    }

Here is the caller graph for this function:

createTestArchiveExport()

ilTestExportGUI::createTestArchiveExport

(

)

Definition at line 111 of file class.ilTestExportGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilTestEvaluation\getAllActivesPasses(), ilFileUtils\ilTempnam(), ILIAS\Repository\lng(), and ilFileUtils\makeDirParents().

    {
        if ($this->access->checkAccess('write', '', $this->obj->getRefId())) {
            // prepare generation before contents are processed (for mathjax)

            $evaluation = new ilTestEvaluation($this->db, $this->obj->getTestId());
            $allActivesPasses = $evaluation->getAllActivesPasses();
            $participantData = new ilTestParticipantData($this->db, $this->lng);
            $participantData->setActiveIdsFilter(array_keys($allActivesPasses));
            $participantData->load($this->obj->getTestId());

            $archiveService = new ilTestArchiveService(
                $this->obj,
                $this->lng,
                $this->obj_cache,
                $this->html_generator
            );
            $archiveService->setParticipantData($participantData);
            $archiveService->archivePassesByActives($allActivesPasses);

            $test_id = $this->obj->getId();
            $test_ref = $this->obj->getRefId();
            $archive_exp = new ilTestArchiver($test_id, $test_ref);

            $scoring = new ilTestScoring($this->obj, $this->db);
            $best_solution = $scoring->calculateBestSolutionForTest();

            $tmpFileName = ilFileUtils::ilTempnam();
            if (!is_dir($tmpFileName)) {
                ilFileUtils::makeDirParents($tmpFileName);
            }

            $archive_exp->handInTestBestSolution($best_solution);

            $archive_exp->updateTestArchive();
            $archive_exp->compressTestArchive();
        } else {
            $this->tpl->setOnScreenMessage('info', 'cannot_export_archive', true);
        }
        $this->ctrl->redirectByClass('iltestexportgui');
    }

Here is the call graph for this function:

createTestExportWithResults()

ilTestExportGUI::createTestExportWithResults

(

)

Create test export file.

Definition at line 77 of file class.ilTestExportGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

    {
        if (!$this->access->checkAccess('write', '', $this->obj->getRefId())) {
            $this->tpl->setOnScreenMessage('info', 'cannot_export_archive', true);
            $this->ctrl->redirectByClass(self::class);
        }

        $this->ctrl->setParameterByClass(self::class, 'export_results', 1);
        (new ilExport())->exportObject($this->obj->getType(), $this->obj->getId());
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('exp_file_created'), true);
        $this->ctrl->redirectByClass('iltestexportgui');
    }

Here is the call graph for this function:

createTestResultsExport()

ilTestExportGUI::createTestResultsExport

(

)

Definition at line 90 of file class.ilTestExportGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

    {
        if (!$this->access->checkAccess('write', '', $this->obj->getRefId())) {
            $this->tpl->setOnScreenMessage('info', 'cannot_export_archive', true);
            $this->ctrl->redirectByClass(self::class);
        }

        $export_factory = new ilTestExportFactory(
            $this->obj,
            $this->lng,
            $this->logger,
            $this->tree,
            $this->component_repository,
            $this->questioninfo
        );
        $test_exp = $export_factory->getExporter('results');
        $test_exp->buildExportFile();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('exp_file_created'), true);
        $this->ctrl->redirectByClass('iltestexportgui');
    }

Here is the call graph for this function:

delete()

ilTestExportGUI::delete

(

)

Definition at line 278 of file class.ilTestExportGUI.php.

References ILIAS\Repository\ctrl(), ilFileUtils\delDir(), ILIAS\Survey\Mode\getId(), ilExportGUI\getParentGUI(), and ILIAS\Repository\lng().

                            : void
    {
        $archiver = new ilTestArchiver($this->getParentGUI()->getTestObject()->getId());
        $archiveDir = $archiver->getZipExportDirectory();

        $export_dir = $this->obj->getExportDirectory();
        foreach ($this->selected_files as $file) {
            $file = basename($file);
            $dir = substr($file, 0, strlen($file) - 4);

            if (!strlen($file) || !strlen($dir)) {
                continue;
            }

            $exp_file = $export_dir . '/' . $file;
            $arc_file = $archiveDir . '/' . $file;
            $exp_dir = $export_dir . '/' . $dir;
            if (@is_file($exp_file)) {
                unlink($exp_file);
            }
            if (@is_file($arc_file)) {
                unlink($arc_file);
            }
            if (@is_dir($exp_dir)) {
                ilFileUtils::delDir($exp_dir);
            }
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_deleted_export_files'), true);
        $this->ctrl->redirect($this, 'listExportFiles');
    }

Here is the call graph for this function:

download()

ilTestExportGUI::download

(

)

Definition at line 249 of file class.ilTestExportGUI.php.

References $filename, ILIAS\Repository\ctrl(), ilFileDelivery\deliverFileLegacy(), ILIAS\Survey\Mode\getId(), ilExportGUI\getParentGUI(), and ILIAS\Repository\lng().

                              : void
    {
        if ($this->selected_files === []) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_checkbox'), true);
            $this->ctrl->redirect($this, 'listExportFiles');
        }

        if (count($this->selected_files) > 1) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_max_one_item'), true);
            $this->ctrl->redirect($this, 'listExportFiles');
        }

        $archiver = new ilTestArchiver($this->getParentGUI()->getTestObject()->getId());

        $filename = basename($this->selected_files[0]);
        $exportFile = $this->obj->getExportDirectory() . '/' . $filename;
        $archiveFile = $archiver->getZipExportDirectory() . '/' . $filename;

        if (file_exists($exportFile)) {
            ilFileDelivery::deliverFileLegacy($exportFile, $filename);
        }

        if (file_exists($archiveFile)) {
            ilFileDelivery::deliverFileLegacy($archiveFile, $filename);
        }

        $this->ctrl->redirect($this, 'listExportFiles');
    }

Here is the call graph for this function:

getExportTypeFromFileName()

ilTestExportGUI::getExportTypeFromFileName ( string  $export_file )

private

Definition at line 240 of file class.ilTestExportGUI.php.

References ILIAS\Repository\lng().

Referenced by listExportFiles().

    {
        $extension = strtoupper(pathinfo($export_file, PATHINFO_EXTENSION));
        if (in_array($extension, ['XLSX', 'CSV', 'XLS'])) {
            return $this->lng->txt('results');
        }
        return $extension;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listExportFiles()

ilTestExportGUI::listExportFiles

(

)

Definition at line 153 of file class.ilTestExportGUI.php.

References Vendor\Package\$c, $data, Vendor\Package\$f, buildExportTableGUI(), ILIAS\Repository\ctrl(), ilExportGUI\getCustomColumns(), ilExportGUI\getCustomMultiCommands(), getExportTypeFromFileName(), ilExportGUI\getFormats(), ILIAS\Survey\Mode\getId(), ilExportGUI\getParentGUI(), ILIAS\Repository\lng(), ilSelectInputGUI\setOptions(), and ILIAS\Repository\toolbar().

                                     : void
    {
        $this->toolbar->setFormAction($this->ctrl->getFormAction($this));

        if (count($this->getFormats()) > 1) {
            foreach ($this->getFormats() as $f) {
                $options[$f['key']] = $f['txt'];
            }
            $si = new ilSelectInputGUI($this->lng->txt('type'), 'format');
            $si->setOptions($options);
            $this->toolbar->addInputItem($si, true);
            $this->toolbar->addFormButton($this->lng->txt('exp_create_file'), 'createExportFile');
        } else {
            $format = $this->getFormats()[0];
            $this->toolbar->addFormButton(
                $this->lng->txt('exp_create_file')
                . ' (' . $format['txt'] . ')',
                'create_' . $format['key']
            );
        }

        $archiver = new ilTestArchiver($this->getParentGUI()->getTestObject()->getId());
        $archive_dir = $archiver->getZipExportDirectory();
        $archive_files = [];

        if (file_exists($archive_dir) && is_dir($archive_dir)) {
            $archive_files = scandir($archive_dir);
        }

        $export_dir = $this->obj->getExportDirectory();
        $export_files = $this->obj->getExportFiles($export_dir);
        $data = [];
        if (count($export_files) > 0) {
            foreach ($export_files as $exp_file) {
                $file_arr = explode('__', $exp_file);
                if ($file_arr[0] == $exp_file) {
                    continue;
                }

                array_push(
                    $data,
                    [
                        'file' => $exp_file,
                        'size' => filesize($export_dir . '/' . $exp_file),
                        'timestamp' => $file_arr[0],
                        'type' => $this->getExportTypeFromFileName($exp_file)
                    ]
                );
            }
        }

        if (count($archive_files) > 0) {
            foreach ($archive_files as $exp_file) {
                if ($exp_file == '.' || $exp_file == '..') {
                    continue;
                }
                $file_arr = explode('_', $exp_file);

                $data[] = [
                    'file' => $exp_file,
                    'size' => filesize($archive_dir . '/' . $exp_file),
                    'timestamp' => $file_arr[4],
                    'type' => $this->getExportTypeFromFileName($exp_file)
                ];
            }
        }

        $table = $this->buildExportTableGUI();
        $table->setSelectAllCheckbox('file');
        foreach ($this->getCustomColumns() as $c) {
            $table->addCustomColumn($c['txt'], $c['obj'], $c['func']);
        }

        foreach ($this->getCustomMultiCommands() as $c) {
            $table->addCustomMultiCommand($c['txt'], 'multi_' . $c['func']);
        }

        $table->resetFormats();
        foreach ($this->formats as $format) {
            $table->addFormat($format['key']);
        }

        $table->setData($data);
        $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_manual_feedback_export_info'), true);
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• Modules/Test/classes/class.ilTestExportGUI.php