ilTestArchiver Class Reference

Collaboration diagram for ilTestArchiver:

Public Member Functions
	getParticipantData ()
	setParticipantData (ilTestParticipantData $participant_data)
	handInParticipantQuestionMaterial (int $active_fi, int $pass, int $question_fi, string $original_filename, string $file_path)
	handInParticipantMisc (int $active_fi, int $pass, string $original_filename, string $file_path)
	handInTestBestSolution (string $best_solution)
	handInParticipantUploadedResults (int $active_fi, int $pass, ilObjTest $tst_obj)
	handInBestSolutionQuestionMaterial (int $question_fi, string $orginial_filename, string $file_path)
	handInTestResult (int $active_fi, int $pass, string $pdf_path)
	updateTestArchive ()
	ensureZipExportDirectoryExists ()
	hasZipExportDirectory ()
	getZipExportDirectory ()
	compressTestArchive ()
	getResultsOfUserOutput (\ilObjTest $test_obj, ilTestSession $test_session, array $participant_data, int $active_id, int $attempt)

Data Fields
const	DIR_SEP = DIRECTORY_SEPARATOR
const	EXPORT_DIRECTORY = 'archive_exports'

Protected Member Functions
	hasTestArchive ()
	createArchiveForTest ()
	getTestArchive ()
	ensureTestArchiveIsAvailable ()
	createZipExportDirectory ()
	hasPassDataDirectory (int $active_fi, int $pass)
	createPassDataDirectory (int $active_fi, int $pass)
	getPassDataDirectory (int $active_fi, int $pass)
	ensurePassDataDirectoryIsAvailable (int $active_fi, int $pass)
	hasPassMaterialsDirectory (int $active_fi, int $pass)
	createPassMaterialsDirectory (int $active_fi, int $pass)
	getPassMaterialsDirectory (int $active_fi, int $pass)
	ensurePassMaterialsDirectoryIsAvailable (int $active_fi, int $pass)
	readArchiveDataIndex ()
	appendToArchiveDataIndex (string $date, int $active_fi, int $pass, string $user_firstname, string $user_lastname, string $matriculation)

Protected Attributes
ilTestHTMLGenerator	$html_generator
ilTestParticipantData	$participant_data = null

Private Member Functions
	buildPassDataDirectory ($active_fi, $pass)
	determinePassDataPath (string $date, int $active_fi, int $pass, string $user_firstname, string $user_lastname, string $matriculation)
	createUserResultsForArchive (\ilObjTest $test_obj, array $active_ids,)
	getColumnsForAttemptOverviewTable (bool $show_requested_hints_info)
	getDataRetrievalForAttemptOverviewTable (array $result_data)
	logArchivingProcess (string $message)

Private Attributes
const	PASS_MATERIALS_PATH_COMPONENT = 'materials'
const	QUESTION_PATH_COMPONENT_PREFIX = 'q_'
const	TEST_BEST_SOLUTION_PATH_COMPONENT = 'best_solution'
const	HTML_BEST_SOLUTION_FILENAME = 'best_solution.html'
const	TEST_MATERIALS_PATH_COMPONENT = 'materials'
const	TEST_RESULT_FILENAME = 'test_result.html'
const	LOG_DTSGROUP_FORMAT = 'D M j G:i:s T Y'
const	LOG_ADDITION_STRING = ' Adding '
const	TEST_LOG_FILENAME = 'test_log.xlsx'
const	DATA_INDEX_FILENAME = 'data_index.csv'
const	ARCHIVE_LOG = 'archive.log'
string	$external_directory_path
string	$client_id = CLIENT_ID
	$archive_data_index

Detailed Description

Author

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

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

Member Function Documentation

appendToArchiveDataIndex()

ilTestArchiver::appendToArchiveDataIndex ( string  $date, int  $active_fi, int  $pass, string  $user_firstname, string  $user_lastname, string  $matriculation  )

protected

Definition at line 474 of file class.ilTestArchiver.php.

References determinePassDataPath(), getTestArchive(), and readArchiveDataIndex().

Referenced by createPassMaterialsDirectory(), and getPassDataDirectory().

     : void {
        $line = $this->determinePassDataPath($date, $active_fi, $pass, $user_firstname, $user_lastname, $matriculation);

        $this->archive_data_index[] = $line;
        $output_contents = '';

        foreach ($this->archive_data_index as $line_data) {
            if ($line_data['identifier'] == "|") {
                continue;
            }
            $output_contents .= implode('|', $line_data) . "\n";
        }

        file_put_contents($this->getTestArchive() . DIRECTORY_SEPARATOR . self::DATA_INDEX_FILENAME, $output_contents);
        $this->readArchiveDataIndex();
        return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildPassDataDirectory()

ilTestArchiver::buildPassDataDirectory (   $active_fi,   $pass  )

private

Definition at line 337 of file class.ilTestArchiver.php.

References getTestArchive().

Referenced by getPassDataDirectory().

                                                              : ?string
    {
        foreach ($this->archive_data_index as $data_index_entry) {
            if ($data_index_entry != null && $data_index_entry['identifier'] == $active_fi . '|' . $pass) {
                array_shift($data_index_entry);
                return $this->getTestArchive() . DIRECTORY_SEPARATOR . implode(DIRECTORY_SEPARATOR, $data_index_entry);
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

compressTestArchive()

ilTestArchiver::compressTestArchive

(

)

Definition at line 314 of file class.ilTestArchiver.php.

References ensureZipExportDirectoryExists(), getTestArchive(), getZipExportDirectory(), updateTestArchive(), and ilFileUtils\zip().

                                         : void
    {
        $this->updateTestArchive();
        $this->ensureZipExportDirectoryExists();

        $zip_output_path = $this->getZipExportDirectory();
        $zip_output_filename = 'test_archive_obj_' . $this->test_obj_id . '_' . time() . '.zip';

        ilFileUtils::zip($this->getTestArchive(), $zip_output_path . DIRECTORY_SEPARATOR . $zip_output_filename, true);
        return;
    }

Here is the call graph for this function:

createArchiveForTest()

ilTestArchiver::createArchiveForTest ( )

protected

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

References getTestArchive(), and ilFileUtils\makeDirParents().

Referenced by ensureTestArchiveIsAvailable().

                                             : void
    {
        ilFileUtils::makeDirParents($this->getTestArchive());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createPassDataDirectory()

ilTestArchiver::createPassDataDirectory ( int  $active_fi, int  $pass  )

protected

Definition at line 331 of file class.ilTestArchiver.php.

References getPassDataDirectory().

Referenced by ensurePassDataDirectoryIsAvailable().

                                                                         : void
    {
        mkdir($this->getPassDataDirectory($active_fi, $pass), 0777, true);
        return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createPassMaterialsDirectory()

ilTestArchiver::createPassMaterialsDirectory ( int  $active_fi, int  $pass  )

protected

Data is taken from the current user as the implementation expects the first interaction of the pass takes place from the usage/behaviour of the current user. (skergomard, 11.09.24: Whatever the f*** this means.)

Definition at line 401 of file class.ilTestArchiver.php.

References appendToArchiveDataIndex(), getParticipantData(), getPassMaterialsDirectory(), and ILIAS\Repository\lng().

Referenced by ensurePassMaterialsDirectoryIsAvailable().

                                                                              : string
    {
        $user = $this->user;

        if ($this->getParticipantData()) {
            $usrData = $this->getParticipantData()->getUserDataByActiveId($active_fi);
            $user = new ilObjUser();
            $user->setFirstname($usrData['firstname'] ?? $this->lng->txt('deleted_user'));
            $user->setLastname($usrData['lastname'] ?? '');
            $user->setMatriculation($usrData['matriculation'] ?? '');
        }

        $this->appendToArchiveDataIndex(
            date('c'),
            $active_fi,
            $pass,
            $user->getFirstname(),
            $user->getLastname(),
            $user->getMatriculation()
        );
        $material_directory = $this->getPassMaterialsDirectory($active_fi, $pass);
        mkdir($material_directory, 0777, true);
        return $material_directory;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createUserResultsForArchive()

ilTestArchiver::createUserResultsForArchive ( \ilObjTest  $test_obj, array  $active_ids  )

private

Definition at line 522 of file class.ilTestArchiver.php.

References $results, ilObjTest\_getResultPass(), ilTestParticipantData\getActiveIds(), ilObject\getRefId(), getResultsOfUserOutput(), ilObjTest\getTestId(), ilTestParticipantData\getUserDataByActiveId(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilTestParticipantData\load(), ilTestParticipantData\setActiveIdsFilter(), ilTestParticipantData\setParticipantAccessFilter(), and ILIAS\Repository\user().

Referenced by updateTestArchive().

     : string {
        $template = new ilTemplate('tpl.il_as_tst_participants_result_output.html', true, true, 'components/ILIAS/Test');

        $participant_data = new ilTestParticipantData($this->db, $this->lng);
        $participant_data->setParticipantAccessFilter(
            $this->participant_access_filter_factory->getAccessResultsUserFilter($test_obj->getRefId())
        );
        $participant_data->setActiveIdsFilter($active_ids);
        $participant_data->load($test_obj->getTestId());

        $test_session_factory = new ilTestSessionFactory($test_obj, $this->db, $this->user);

        $count = 0;
        foreach ($active_ids as $active_id) {
            if (!in_array($active_id, $participant_data->getActiveIds())) {
                continue;
            }

            $count++;
            $results = '';
            if ($active_id > 0) {
                $results = $this->getResultsOfUserOutput(
                    $test_obj,
                    $test_session_factory->getSession($active_id),
                    $participant_data->getUserDataByActiveId($active_id),
                    (int) $active_id,
                    ilObjTest::_getResultPass($active_id)
                );
            }
            if ($count < count($active_ids)) {
                $template->touchBlock('break');
            }
            $template->setCurrentBlock('user_result');
            $template->setVariable('USER_RESULT', $results);
            $template->parseCurrentBlock();
        }

        return $template->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createZipExportDirectory()

ilTestArchiver::createZipExportDirectory ( )

protected

Definition at line 303 of file class.ilTestArchiver.php.

References getZipExportDirectory().

Referenced by ensureZipExportDirectoryExists().

                                                 : void
    {
        mkdir($this->getZipExportDirectory(), 0777, true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

determinePassDataPath()

ilTestArchiver::determinePassDataPath ( string  $date, int  $active_fi, int  $pass, string  $user_firstname, string  $user_lastname, string  $matriculation  )

private

Definition at line 499 of file class.ilTestArchiver.php.

Referenced by appendToArchiveDataIndex().

     : array {
        $parsed_date = date_create_from_format('Y-m-d\TH:i:sP', $date);
        if (!$parsed_date) {
            throw new Exception('Invalid date format. Expected ISO 8601 format.');
        }

        $line = [
            'identifier' => $active_fi . '|' . $pass,
            'yyyy' => date_format($parsed_date, 'Y'),
            'mm' => date_format($parsed_date, 'm'),
            'dd' => date_format($parsed_date, 'd'),
            'directory' => $active_fi . '_' . $pass . '_' . $user_firstname . '_' . $user_lastname . '_' . $matriculation
        ];
        return $line;
    }

Here is the caller graph for this function:

ensurePassDataDirectoryIsAvailable()

ilTestArchiver::ensurePassDataDirectoryIsAvailable ( int  $active_fi, int  $pass  )

protected

Definition at line 385 of file class.ilTestArchiver.php.

References createPassDataDirectory(), and hasPassDataDirectory().

Referenced by handInParticipantMisc(), handInParticipantQuestionMaterial(), handInParticipantUploadedResults(), and handInTestResult().

                                                                                    : void
    {
        if (!$this->hasPassDataDirectory($active_fi, $pass)) {
            $this->createPassDataDirectory($active_fi, $pass);
        }
        return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ensurePassMaterialsDirectoryIsAvailable()

ilTestArchiver::ensurePassMaterialsDirectoryIsAvailable ( int  $active_fi, int  $pass  )

protected

Definition at line 437 of file class.ilTestArchiver.php.

References createPassMaterialsDirectory(), and hasPassMaterialsDirectory().

Referenced by handInParticipantUploadedResults().

                                                                                         : void
    {
        if (!$this->hasPassMaterialsDirectory($active_fi, $pass)) {
            $this->createPassMaterialsDirectory($active_fi, $pass);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ensureTestArchiveIsAvailable()

ilTestArchiver::ensureTestArchiveIsAvailable ( )

protected

Definition at line 252 of file class.ilTestArchiver.php.

References createArchiveForTest(), and hasTestArchive().

Referenced by handInBestSolutionQuestionMaterial(), handInParticipantMisc(), handInParticipantQuestionMaterial(), handInParticipantUploadedResults(), handInTestBestSolution(), and handInTestResult().

                                                     : void
    {
        if (!$this->hasTestArchive()) {
            $this->createArchiveForTest();
        }
        return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ensureZipExportDirectoryExists()

ilTestArchiver::ensureZipExportDirectoryExists

(

)

Definition at line 291 of file class.ilTestArchiver.php.

References createZipExportDirectory(), and hasZipExportDirectory().

Referenced by compressTestArchive().

                                                    : void
    {
        if (!$this->hasZipExportDirectory()) {
            $this->createZipExportDirectory();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColumnsForAttemptOverviewTable()

ilTestArchiver::getColumnsForAttemptOverviewTable ( bool  $show_requested_hints_info )

private

Definition at line 637 of file class.ilTestArchiver.php.

References ILIAS\Repository\lng().

Referenced by getResultsOfUserOutput().

     : array {
        $cf = $this->ui_factory->table()->column();
        $columns = [
            'order' => $cf->number($this->lng->txt('order')),
            'question_id' => $cf->number($this->lng->txt('question_id')),
            'title' => $cf->text($this->lng->txt('tst_question_title')),
            'reachable_points' => $cf->number($this->lng->txt('tst_maximum_points')),
            'reached_points' => $cf->number($this->lng->txt('tst_reached_points'))
        ];
        if ($show_requested_hints_info) {
            $columns['hints'] = $cf->number($this->lng->txt('tst_question_hints_requested_hint_count_header'));
        }
        $columns['solved'] = $cf->text($this->lng->txt('tst_percent_solved'));
        return $columns;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDataRetrievalForAttemptOverviewTable()

ilTestArchiver::getDataRetrievalForAttemptOverviewTable ( array  $result_data )

private

Definition at line 655 of file class.ilTestArchiver.php.

References ILIAS\UI\Implementation\Component\Table\$range, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow().

Referenced by getResultsOfUserOutput().

                                                                                : DataRetrieval
    {
        return new class ($result_data) implements DataRetrieval {
            public function __construct(
                private readonly array $result_data
            ) {
            }

            public function getRows(
                DataRowBuilder $row_builder,
                array $visible_column_ids,
                Range $range,
                Order $order,
                ?array $filter_data,
                ?array $additional_parameters
            ): \Generator {
                $i = 1;
                foreach ($this->result_data as $result) {
                    if (!isset($result['qid'])) {
                        continue;
                    }
                    yield $row_builder->buildDataRow(
                        (string) $result['qid'],
                        [
                            'order' => $i++,
                            'question_id' => $result['qid'],
                            'title' => $result['title'],
                            'reachable_points' => $result['max'],
                            'reached_points' => $result['reached'],
                            'hints' => $result['requested_hints'] ?? 0,
                            'solved' => $result['percent']
                        ]
                    );
                }
            }

            public function getTotalRowCount(
                ?array $filter_data,
                ?array $additional_parameters
            ): ?int {
                return count($this->result_data);
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParticipantData()

ilTestArchiver::getParticipantData

(

)

Definition at line 88 of file class.ilTestArchiver.php.

References $participant_data.

Referenced by createPassMaterialsDirectory(), and getPassDataDirectory().

                                        : ?ilTestParticipantData
    {
        return $this->participant_data;
    }

Here is the caller graph for this function:

getPassDataDirectory()

ilTestArchiver::getPassDataDirectory ( int  $active_fi, int  $pass  )

protected

Definition at line 349 of file class.ilTestArchiver.php.

References appendToArchiveDataIndex(), buildPassDataDirectory(), getParticipantData(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by createPassDataDirectory(), getPassMaterialsDirectory(), handInParticipantMisc(), handInParticipantQuestionMaterial(), handInTestResult(), and hasPassDataDirectory().

                                                                      : ?string
    {
        $pass_data_dir = $this->buildPassDataDirectory($active_fi, $pass);

        if ($pass_data_dir !== null) {
            return $pass_data_dir;
        }

        $test_obj = new ilObjTest($this->test_obj_id, false);
        if ($test_obj->getAnonymity()) {
            $firstname = $this->lng->txt('anonymous');
            $lastname = '';
            $matriculation = '';
        } elseif ($this->getParticipantData()) {
            $usr_data = $this->getParticipantData()->getUserDataByActiveId($active_fi);
            $firstname = $usr_data['firstname'] ?? $this->lng->txt('deleted_user');
            $lastname = $usr_data['lastname'] ?? '';
            $matriculation = $usr_data['matriculation'] ?? '';
        } else {
            $firstname = $this->user->getFirstname();
            $lastname = $this->user->getLastname();
            $matriculation = $this->user->getMatriculation();
        }

        $this->appendToArchiveDataIndex(
            date(DATE_ISO8601),
            $active_fi,
            $pass,
            $firstname,
            $lastname,
            $matriculation
        );

        return $this->buildPassDataDirectory($active_fi, $pass);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPassMaterialsDirectory()

ilTestArchiver::getPassMaterialsDirectory ( int  $active_fi, int  $pass  )

protected

Definition at line 431 of file class.ilTestArchiver.php.

References getPassDataDirectory().

Referenced by createPassMaterialsDirectory(), handInParticipantUploadedResults(), and hasPassMaterialsDirectory().

                                                                           : string
    {
        $pass_data_directory = $this->getPassDataDirectory($active_fi, $pass);
        return $pass_data_directory . DIRECTORY_SEPARATOR . self::PASS_MATERIALS_PATH_COMPONENT;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getResultsOfUserOutput()

ilTestArchiver::getResultsOfUserOutput	(	\ilObjTest	$test_obj,
		ilTestSession	$test_session,
		array	$participant_data,
		int	$active_id,
		int	$attempt
	)

Definition at line 565 of file class.ilTestArchiver.php.

References $results, ilTestSession\getActiveId(), ilObjTest\getAnonymity(), getColumnsForAttemptOverviewTable(), getDataRetrievalForAttemptOverviewTable(), ilObjTest\getResultsForActiveId(), ilObjTest\getTestResult(), ilObjTest\isOfferingQuestionHintsEnabled(), ilObjTest\isShowExamIdInTestResultsEnabled(), ILIAS\Repository\lng(), ilObjTest\lookupExamId(), and ILIAS\Repository\user().

Referenced by createUserResultsForArchive().

     : string {
        $template = new ilTemplate('tpl.il_as_tst_results_participant.html', true, true, 'components/ILIAS/Test');

        $uname = "{$participant_data['firstname']} {$participant_data['lastname']}";
        if ($test_obj->getAnonymity()) {
            $uname = $this->lng->txt('anonymous');
        }

        $test_result_title_builder = new ResultsTitleBuilder($this->lng, $this->obj_cache);

        $result_array = $test_obj->getTestResult(
            $active_id,
            $attempt,
            false,
            true
        );

        $table = $this->ui_factory->table()->data(
            $test_result_title_builder->getPassDetailsHeaderLabel($attempt + 1),
            $this->getColumnsForAttemptOverviewTable($test_obj->isOfferingQuestionHintsEnabled()),
            $this->getDataRetrievalForAttemptOverviewTable($result_array)
        )->withRequest($this->request);
        $template->setVariable(
            'PASS_DETAILS',
            $this->ui_renderer->render($table)
        );

        if ($test_obj->isShowExamIdInTestResultsEnabled()) {
            $template->setCurrentBlock('exam_id_footer');
            $template->setVariable('EXAM_ID_VAL', ilObjTest::lookupExamId(
                $test_session->getActiveId(),
                $attempt
            ));
            $template->setVariable('EXAM_ID_TXT', $this->lng->txt('exam_id'));
            $template->parseCurrentBlock();
        }

        $template->setCurrentBlock('participant_block_id');
        $template->setVariable('PARTICIPANT_BLOCK_ID', "participant_active_{$active_id}");
        $template->parseCurrentBlock();

        $template->setVariable('TEXT_HEADING', sprintf($this->lng->txt('tst_result_user_name'), $uname));

        if ($participant_data['matriculation'] !== '') {
            $template->setVariable('USER_DATA', "{$this->lng->txt('matriculation')}: {$participant_data['matriculation']}");
        }

        $results = $test_obj->getResultsForActiveId($active_id);
        $status = $this->lng->txt($results['passed'] ? 'passed_official' : 'failed_official');
        $template->setVariable(
            'GRADING_MESSAGE',
            "{$this->lng->txt('passed_status')}: {$status}<br>"
            . "{$this->lng->txt('tst_mark')}: {$results['mark_official']}"
        );

        $template->setVariable('PASS_FINISH_DATE_LABEL', $this->lng->txt('tst_pass_finished_on'));
        $template->setVariable(
            'PASS_FINISH_DATE_VALUE',
            (new \DateTimeImmutable('@' . ilObjTest::lookupLastTestPassAccess($active_id, $attempt)))
                ->setTimezone(new DateTimeZone($this->user->getTimeZone()))
                ->format($this->user->getDateTimeFormat()->toString())
        );

        return $template->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTestArchive()

ilTestArchiver::getTestArchive ( )

protected

Definition at line 245 of file class.ilTestArchiver.php.

Referenced by appendToArchiveDataIndex(), buildPassDataDirectory(), compressTestArchive(), createArchiveForTest(), handInBestSolutionQuestionMaterial(), handInTestBestSolution(), hasTestArchive(), logArchivingProcess(), readArchiveDataIndex(), and updateTestArchive().

                                       : string
    {
        $test_archive_directory = $this->external_directory_path . DIRECTORY_SEPARATOR . $this->client_id . DIRECTORY_SEPARATOR . 'tst_data'
            . DIRECTORY_SEPARATOR . 'archive' . DIRECTORY_SEPARATOR . 'tst_' . $this->test_obj_id;
        return $test_archive_directory;
    }

Here is the caller graph for this function:

getZipExportDirectory()

ilTestArchiver::getZipExportDirectory

(

)

Definition at line 308 of file class.ilTestArchiver.php.

Referenced by compressTestArchive(), createZipExportDirectory(), and hasZipExportDirectory().

                                           : string
    {
        return $this->external_directory_path . DIRECTORY_SEPARATOR . $this->client_id . DIRECTORY_SEPARATOR . 'tst_data'
            . DIRECTORY_SEPARATOR . self::EXPORT_DIRECTORY . DIRECTORY_SEPARATOR . 'tst_' . $this->test_obj_id;
    }

Here is the caller graph for this function:

handInBestSolutionQuestionMaterial()

ilTestArchiver::handInBestSolutionQuestionMaterial	(	int	$question_fi,
		string	$orginial_filename,
		string	$file_path
	)

Definition at line 196 of file class.ilTestArchiver.php.

References ensureTestArchiveIsAvailable(), getTestArchive(), and logArchivingProcess().

     : void {
        $this->ensureTestArchiveIsAvailable();

        $best_solution_path = $this->getTestArchive() . DIRECTORY_SEPARATOR . self::TEST_BEST_SOLUTION_PATH_COMPONENT;
        if (!is_dir($best_solution_path)) {
            mkdir($best_solution_path, 0777, true);
        }

        $materials_path = $best_solution_path . DIRECTORY_SEPARATOR . self::TEST_MATERIALS_PATH_COMPONENT;
        if (!is_dir($materials_path)) {
            mkdir($materials_path, 0777, true);
        }

        $question_materials_path = $materials_path . DIRECTORY_SEPARATOR . self::QUESTION_PATH_COMPONENT_PREFIX . $question_fi;
        if (!is_dir($question_materials_path)) {
            mkdir($question_materials_path, 0777, true);
        }

        copy($file_path, $question_materials_path . DIRECTORY_SEPARATOR . $orginial_filename);

        $this->logArchivingProcess(
            date(self::LOG_DTSGROUP_FORMAT) . self::LOG_ADDITION_STRING
            . $question_materials_path . DIRECTORY_SEPARATOR . $orginial_filename
        );
    }

Here is the call graph for this function:

handInParticipantMisc()

ilTestArchiver::handInParticipantMisc	(	int	$active_fi,
		int	$pass,
		string	$original_filename,
		string	$file_path
	)

Definition at line 122 of file class.ilTestArchiver.php.

References ensurePassDataDirectoryIsAvailable(), ensureTestArchiveIsAvailable(), getPassDataDirectory(), and logArchivingProcess().

     : void {
        $this->ensureTestArchiveIsAvailable();
        $this->ensurePassDataDirectoryIsAvailable($active_fi, $pass);
        $new_path = $this->getPassDataDirectory($active_fi, $pass) . DIRECTORY_SEPARATOR . $original_filename;
        copy($file_path, $new_path);
        $this->logArchivingProcess(date(self::LOG_DTSGROUP_FORMAT) . self::LOG_ADDITION_STRING . $new_path);
    }

Here is the call graph for this function:

handInParticipantQuestionMaterial()

ilTestArchiver::handInParticipantQuestionMaterial	(	int	$active_fi,
		int	$pass,
		int	$question_fi,
		string	$original_filename,
		string	$file_path
	)

Definition at line 98 of file class.ilTestArchiver.php.

References ensurePassDataDirectoryIsAvailable(), ensureTestArchiveIsAvailable(), getPassDataDirectory(), and logArchivingProcess().

     : void {
        $this->ensureTestArchiveIsAvailable();
        $this->ensurePassDataDirectoryIsAvailable($active_fi, $pass);

        $pass_question_directory = $this->getPassDataDirectory($active_fi, $pass)
            . DIRECTORY_SEPARATOR . self::QUESTION_PATH_COMPONENT_PREFIX . $question_fi;
        if (!is_dir($pass_question_directory)) {
            mkdir($pass_question_directory, 0777, true);
        }

        copy($file_path, $pass_question_directory . DIRECTORY_SEPARATOR . $original_filename);

        $this->logArchivingProcess(
            date(self::LOG_DTSGROUP_FORMAT) . self::LOG_ADDITION_STRING
            . $pass_question_directory . DIRECTORY_SEPARATOR . $original_filename
        );
    }

Here is the call graph for this function:

handInParticipantUploadedResults()

ilTestArchiver::handInParticipantUploadedResults	(	int	$active_fi,
		int	$pass,
		ilObjTest	$tst_obj
	)

Definition at line 159 of file class.ilTestArchiver.php.

References ensurePassDataDirectoryIsAvailable(), ensurePassMaterialsDirectoryIsAvailable(), ensureTestArchiveIsAvailable(), getPassMaterialsDirectory(), ilObjTest\getQuestionDataset(), ilObjTest\getQuestionsOfPass(), and ilObjTest\getTextAnswer().

     : void {
        $questions = $tst_obj->getQuestionsOfPass($active_fi, $pass);
        foreach ($questions as $question) {
            $question = $tst_obj->getQuestionDataset($question['question_fi']);
            if ($question->type_tag === 'assFileUpload') {
                $this->ensureTestArchiveIsAvailable();
                $this->ensurePassDataDirectoryIsAvailable($active_fi, $pass);
                $this->ensurePassMaterialsDirectoryIsAvailable($active_fi, $pass);
                $pass_material_directory = $this->getPassMaterialsDirectory($active_fi, $pass);
                $archive_folder = $pass_material_directory . DIRECTORY_SEPARATOR . $question->question_id . DIRECTORY_SEPARATOR;
                if (!file_exists($archive_folder)) {
                    mkdir($archive_folder, 0777, true);
                }
                $resource_id = $tst_obj->getTextAnswer($active_fi, $question->question_id, $pass);
                if ($resource_id === '') {
                    continue;
                }
                $irss_unique_id = $this->irss->manage()->find($resource_id);
                if ($irss_unique_id != null) {
                    $resource = $this->irss->manage()->getResource($irss_unique_id);
                    $information = $resource->getCurrentRevision()->getInformation();
                    $stream = $this->irss->consume()->stream($irss_unique_id);
                    // this feels unnecessary..
                    $file_stream = fopen($stream->getStream()->getMetadata('uri'), 'r');
                    $file_content = stream_get_contents($file_stream);
                    fclose($file_stream);
                    $target_destination = $archive_folder . $information->getTitle();
                    file_put_contents($target_destination, $file_content);
                }
            }
        }
    }

Here is the call graph for this function:

handInTestBestSolution()

ilTestArchiver::handInTestBestSolution

(

string

$best_solution

)

Definition at line 135 of file class.ilTestArchiver.php.

References ensureTestArchiveIsAvailable(), getTestArchive(), and logArchivingProcess().

                                                                 : void
    {
        $this->ensureTestArchiveIsAvailable();

        $best_solution_path = $this->getTestArchive() . DIRECTORY_SEPARATOR . self::TEST_BEST_SOLUTION_PATH_COMPONENT;
        if (!is_dir($best_solution_path)) {
            mkdir($best_solution_path, 0777, true);
        }

        $this->html_generator->generateHTML(
            $best_solution,
            $best_solution_path . DIRECTORY_SEPARATOR . self::HTML_BEST_SOLUTION_FILENAME
        );

        $this->logArchivingProcess(
            date(self::LOG_DTSGROUP_FORMAT) . self::LOG_ADDITION_STRING
            . $best_solution_path . DIRECTORY_SEPARATOR . self::HTML_BEST_SOLUTION_FILENAME
        );

        $this->logArchivingProcess(
            date(self::LOG_DTSGROUP_FORMAT) . self::LOG_ADDITION_STRING . $best_solution_path
        );
    }

Here is the call graph for this function:

handInTestResult()

ilTestArchiver::handInTestResult	(	int	$active_fi,
		int	$pass,
		string	$pdf_path
	)

Definition at line 226 of file class.ilTestArchiver.php.

References ensurePassDataDirectoryIsAvailable(), ensureTestArchiveIsAvailable(), getPassDataDirectory(), and logArchivingProcess().

                                                                                 : void
    {
        $this->ensureTestArchiveIsAvailable();
        $this->ensurePassDataDirectoryIsAvailable($active_fi, $pass);
        $new_path = $this->getPassDataDirectory($active_fi, $pass) . DIRECTORY_SEPARATOR . self::TEST_RESULT_FILENAME;
        copy($pdf_path, $new_path);
        $this->logArchivingProcess(date(self::LOG_DTSGROUP_FORMAT) . self::LOG_ADDITION_STRING . $new_path);
    }

Here is the call graph for this function:

hasPassDataDirectory()

ilTestArchiver::hasPassDataDirectory ( int  $active_fi, int  $pass  )

protected

Definition at line 326 of file class.ilTestArchiver.php.

References getPassDataDirectory().

Referenced by ensurePassDataDirectoryIsAvailable().

                                                                      : bool
    {
        return is_dir($this->getPassDataDirectory($active_fi, $pass));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasPassMaterialsDirectory()

ilTestArchiver::hasPassMaterialsDirectory ( int  $active_fi, int  $pass  )

protected

Definition at line 393 of file class.ilTestArchiver.php.

References getPassMaterialsDirectory().

Referenced by ensurePassMaterialsDirectoryIsAvailable().

                                                                           : bool
    {
        if (is_dir($this->getPassMaterialsDirectory($active_fi, $pass))) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasTestArchive()

ilTestArchiver::hasTestArchive ( )

protected

Definition at line 235 of file class.ilTestArchiver.php.

References getTestArchive().

Referenced by ensureTestArchiveIsAvailable().

                                       : bool
    {
        return is_dir($this->getTestArchive());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasZipExportDirectory()

ilTestArchiver::hasZipExportDirectory

(

)

Definition at line 298 of file class.ilTestArchiver.php.

References getZipExportDirectory().

Referenced by ensureZipExportDirectoryExists().

                                           : bool
    {
        return is_dir($this->getZipExportDirectory());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logArchivingProcess()

ilTestArchiver::logArchivingProcess ( string  $message )

private

Definition at line 700 of file class.ilTestArchiver.php.

References getTestArchive().

Referenced by handInBestSolutionQuestionMaterial(), handInParticipantMisc(), handInParticipantQuestionMaterial(), handInTestBestSolution(), and handInTestResult().

                                                         : void
    {
        $archive = $this->getTestArchive() . DIRECTORY_SEPARATOR . self::ARCHIVE_LOG;
        if (file_exists($archive)) {
            $content = file_get_contents($archive) . "\n" . $message;
        } else {
            $content = $message;
        }

        file_put_contents($archive, $content);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readArchiveDataIndex()

ilTestArchiver::readArchiveDataIndex ( )

protected

The Archive Data Index is a csv-file containing the following columns <active_fi>|<pass>|<yyyy>|<mm>||<directory>

PhpUsageOfSilenceOperatorInspection

Definition at line 444 of file class.ilTestArchiver.php.

References getTestArchive().

Referenced by appendToArchiveDataIndex().

                                             : array
    {
        $data_index_file = $this->getTestArchive() . DIRECTORY_SEPARATOR . self::DATA_INDEX_FILENAME;

        $contents = [];

        if (@file_exists($data_index_file)) {
            $lines = explode("\n", file_get_contents($data_index_file));
            foreach ($lines as $line) {
                if (strlen($line) === 0) {
                    continue;
                }
                $line_items = explode('|', $line);
                $line_data = [];
                $line_data['identifier'] = $line_items[0] . '|' . $line_items[1];
                $line_data['yyyy'] = $line_items[2];
                $line_data['mm'] = $line_items[3];
                $line_data['dd'] = $line_items[4];
                $line_data['directory'] = $line_items[5];
                $contents[] = $line_data;
            }
        }
        return $contents;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setParticipantData()

ilTestArchiver::setParticipantData

(

ilTestParticipantData

$participant_data

)

Definition at line 93 of file class.ilTestArchiver.php.

References $participant_data.

Referenced by ilTestArchiveService\archiveActivesPass().

                                                                               : void
    {
        $this->participant_data = $participant_data;
    }

Here is the caller graph for this function:

updateTestArchive()

ilTestArchiver::updateTestArchive

(

)

Definition at line 260 of file class.ilTestArchiver.php.

References $filename, createUserResultsForArchive(), and getTestArchive().

Referenced by compressTestArchive().

                                       : void
    {
        $this->log_viewer->getLogExportForRefjId(
            $this->test_ref_id
        )->writeToFile(
            $this->getTestArchive() . DIRECTORY_SEPARATOR . self::TEST_LOG_FILENAME
        );

        // Generate test pass overview
        $test = new ilObjTest($this->test_obj_id, false);
        if ($this->test_ref_id !== null) {
            $test->setRefId($this->test_ref_id);
        }

        $array_of_actives = [];
        $participants = $test->getParticipants();

        foreach (array_keys($participants) as $key) {
            $array_of_actives[] = $key;
        }

        $filename = realpath($this->getTestArchive()) . DIRECTORY_SEPARATOR . 'participant_attempt_overview.html';
        $this->html_generator->generateHTML(
            $this->createUserResultsForArchive(
                $test,
                $array_of_actives
            ),
            $filename
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$archive_data_index

ilTestArchiver::$archive_data_index

private

Definition at line 59 of file class.ilTestArchiver.php.

$client_id

string ilTestArchiver::$client_id = CLIENT_ID

private

Definition at line 58 of file class.ilTestArchiver.php.

$external_directory_path

string ilTestArchiver::$external_directory_path

private

Definition at line 57 of file class.ilTestArchiver.php.

$html_generator

ilTestHTMLGenerator ilTestArchiver::$html_generator

protected

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

$participant_data

ilTestParticipantData ilTestArchiver::$participant_data = null

protected

Definition at line 63 of file class.ilTestArchiver.php.

Referenced by getParticipantData(), and setParticipantData().

ARCHIVE_LOG

const ilTestArchiver::ARCHIVE_LOG = 'archive.log'

private

Definition at line 55 of file class.ilTestArchiver.php.

DATA_INDEX_FILENAME

const ilTestArchiver::DATA_INDEX_FILENAME = 'data_index.csv'

private

Definition at line 54 of file class.ilTestArchiver.php.

DIR_SEP

const ilTestArchiver::DIR_SEP = DIRECTORY_SEPARATOR

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

EXPORT_DIRECTORY

const ilTestArchiver::EXPORT_DIRECTORY = 'archive_exports'

Definition at line 39 of file class.ilTestArchiver.php.

Referenced by ilTestExportOptionARC\getDirectory().

HTML_BEST_SOLUTION_FILENAME

const ilTestArchiver::HTML_BEST_SOLUTION_FILENAME = 'best_solution.html'

private

Definition at line 45 of file class.ilTestArchiver.php.

LOG_ADDITION_STRING

const ilTestArchiver::LOG_ADDITION_STRING = ' Adding '

private

Definition at line 51 of file class.ilTestArchiver.php.

LOG_DTSGROUP_FORMAT

const ilTestArchiver::LOG_DTSGROUP_FORMAT = 'D M j G:i:s T Y'

private

Definition at line 50 of file class.ilTestArchiver.php.

PASS_MATERIALS_PATH_COMPONENT

const ilTestArchiver::PASS_MATERIALS_PATH_COMPONENT = 'materials'

private

Definition at line 41 of file class.ilTestArchiver.php.

QUESTION_PATH_COMPONENT_PREFIX

const ilTestArchiver::QUESTION_PATH_COMPONENT_PREFIX = 'q_'

private

Definition at line 42 of file class.ilTestArchiver.php.

TEST_BEST_SOLUTION_PATH_COMPONENT

const ilTestArchiver::TEST_BEST_SOLUTION_PATH_COMPONENT = 'best_solution'

private

Definition at line 44 of file class.ilTestArchiver.php.

TEST_LOG_FILENAME

const ilTestArchiver::TEST_LOG_FILENAME = 'test_log.xlsx'

private

Definition at line 53 of file class.ilTestArchiver.php.

TEST_MATERIALS_PATH_COMPONENT

const ilTestArchiver::TEST_MATERIALS_PATH_COMPONENT = 'materials'

private

Definition at line 46 of file class.ilTestArchiver.php.

TEST_RESULT_FILENAME

const ilTestArchiver::TEST_RESULT_FILENAME = 'test_result.html'

private

Definition at line 48 of file class.ilTestArchiver.php.

---

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

• components/ILIAS/Test/classes/class.ilTestArchiver.php