ilTestExportGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilTestExportGUI:

Collaboration diagram for ilTestExportGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_main_obj=null)
	createTestArchiveExport ()
	listExportFiles ()
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)

Private Attributes
ILIAS Test InternalRequestService	$testrequest

Additional Inherited Members
Protected Attributes inherited from ilExportGUI
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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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$

@ilCtrl_Calls ilTestExportGUI: ilParticipantsTestResultsGUI

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

Constructor & Destructor Documentation

__construct()

ilTestExportGUI::__construct	(		$a_parent_gui,
			$a_main_obj = null
	)

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

    {
        global $DIC;
        $component_factory = $DIC["component.factory"];
        $this->testrequest = $DIC->test()->internal()->request();
        parent::__construct($a_parent_gui, $a_main_obj);
 
        #$this->addFormat('xml', $a_parent_gui->lng->txt('ass_create_export_file'), $this, 'createTestExport');
        $this->addFormat('xml', $DIC->language()->txt('ass_create_export_file'));
        $this->addFormat('xmlres', $DIC->language()->txt('ass_create_export_file_with_results'), $this, 'createTestExportWithResults');
        $this->addFormat('csv', $DIC->language()->txt('ass_create_export_test_results'), $this, 'createTestResultsExport');
        $this->addFormat('arc', $DIC->language()->txt('ass_create_export_test_archive'), $this, 'createTestArchiveExport');
        foreach ($component_factory->getActivePluginsInSlot("texp") as $plugin) {
            $plugin->setTest($this->obj);
            $this->addFormat(
                $plugin->getFormat(),
                $plugin->getFormatLabel(),
                $plugin,
                'export'
            );
        }
    }

References $DIC, XapiProxy\$plugin, ILIAS\GlobalScreen\Provider\__construct(), and ilExportGUI\addFormat().

Here is the call graph for this function:

Member Function Documentation

buildExportTableGUI()

ilTestExportGUI::buildExportTableGUI ( )

protected

Returns

ilTestExportTableGUI

Reimplemented from ilExportGUI.

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

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

Referenced by listExportFiles().

Here is the caller graph for this function:

createTestArchiveExport()

ilTestExportGUI::createTestArchiveExport

(

)

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

    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];
 
        if ($ilAccess->checkAccess("write", "", $this->obj->getRefId())) {
            // prepare generation before contents are processed (for mathjax)
            ilPDFGeneratorUtils::prepareGenerationRequest("Test", PDF_USER_RESULT);
 
            $evaluation = new ilTestEvaluation($ilDB, $this->obj->getTestId());
            $allActivesPasses = $evaluation->getAllActivesPasses();
            $participantData = new ilTestParticipantData($ilDB, $lng);
            $participantData->setActiveIdsFilter(array_keys($allActivesPasses));
            $participantData->load($this->obj->getTestId());
 
            $archiveService = new ilTestArchiveService($this->obj);
            $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);
            $best_solution = $scoring->calculateBestSolutionForTest();
 
            $tmpFileName = ilFileUtils::ilTempnam();
            if (!is_dir($tmpFileName)) {
                ilFileUtils::makeDirParents($tmpFileName);
            }
 
            $directory_name = realpath($tmpFileName);
            $file_name = $directory_name . DIRECTORY_SEPARATOR . 'Best_Solution.pdf';
 
            $generator = new ilTestPDFGenerator();
            $generator->generatePDF($best_solution, ilTestPDFGenerator::PDF_OUTPUT_FILE, $file_name, PDF_USER_RESULT);
            $archive_exp->handInTestBestSolution($best_solution, $file_name);
            ilFileUtils::delDir($directory_name);
 
            $archive_exp->updateTestArchive();
            $archive_exp->compressTestArchive();
        } else {
            $this->tpl->setOnScreenMessage('info', "cannot_export_archive", true);
        }
        $ilCtrl->redirectByClass('iltestexportgui');
    }

References $DIC, $ilDB, ilExportGUI\$lng, ilFileUtils\delDir(), ilFileUtils\ilTempnam(), ilFileUtils\makeDirParents(), ilTestPDFGenerator\PDF_OUTPUT_FILE, PDF_USER_RESULT, and ilPDFGeneratorUtils\prepareGenerationRequest().

Here is the call graph for this function:

getExportTypeFromFileName()

ilTestExportGUI::getExportTypeFromFileName ( string  $export_file )

private

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

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

References ILIAS\Repository\lng().

Referenced by listExportFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

listExportFiles()

ilTestExportGUI::listExportFiles

(

)

Reimplemented from ilExportGUI.

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

                                     : void
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        $tpl = $DIC['tpl'];
        $ilToolbar = $DIC['ilToolbar'];
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
 
        if (!$ilAccess->checkAccess('write', '', $this->obj->getRefId())) {
            $this->tpl->setOnScreenMessage('info', "cannot_export_archive", true);
            $ilCtrl->redirectByClass(ilObjTestGUI::class);
        }
 
        $ilToolbar->setFormAction($ilCtrl->getFormAction($this));
 
        if (count($this->getFormats()) > 1) {
            foreach ($this->getFormats() as $f) {
                $options[$f["key"]] = $f["txt"];
            }
            $si = new ilSelectInputGUI($lng->txt("type"), "format");
            $si->setOptions($options);
            $ilToolbar->addInputItem($si, true);
            $ilToolbar->addFormButton($lng->txt("exp_create_file"), "createExportFile");
        } else {
            $format = $this->getFormats();
            $format = $format[0];
            $ilToolbar->addFormButton($lng->txt("exp_create_file") . " (" . $format["txt"] . ")", "create_" . $format["key"]);
        }
 
        $archiver = new ilTestArchiver($this->getParentGUI()->getTestObject()->getId());
        $archive_dir = $archiver->getZipExportDirectory();
        $archive_files = array();
 
        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 = array();
        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, array(
                    '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', $lng->txt('no_manual_feedback_export_info'), true);
        $tpl->setContent($table->getHTML());
    }

References $c, $data, $DIC, Vendor\Package\$f, $format, ilExportGUI\$lng, ilExportGUI\$tpl, buildExportTableGUI(), ilExportGUI\getCustomColumns(), ilExportGUI\getCustomMultiCommands(), getExportTypeFromFileName(), ilExportGUI\getFormats(), ILIAS\Survey\Mode\getId(), ilExportGUI\getParentGUI(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Here is the call graph for this function:

Field Documentation

$testrequest

ILIAS Test InternalRequestService ilTestExportGUI::$testrequest

private

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

---

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

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