ilTestArchiver Class Reference

Class ilTestArchiver. More...

Collaboration diagram for ilTestArchiver:

Public Member Functions
	getParticipantData ()
	setParticipantData ($participantData)
	handInParticipantQuestionMaterial ($active_fi, $pass, $question_fi, $original_filename, $file_path)
	Hands in a particpants question material, such as an upload or other binary content. More...
	handInParticipantMisc ($active_fi, $pass, $original_filename, $file_path)
	Hands in a participants file, which is relevant for archiving but an unspecified type. More...
	handInTestBestSolution ($best_solution)
	Hands in the best solution for a test. More...
	handInParticipantUploadedResults ($active_fi, $pass, $tst_obj)
	handInBestSolutionQuestionMaterial ($question_fi, $orginial_filename, $file_path)
	Hands in a file related to a question in context of the best solution. More...
	handInTestResult ($active_fi, $pass, $pdf_path)
	Hands in an individual test result for a pass. More...
	updateTestArchive ()
	Replaces the test-log with the current one. More...
	ensureZipExportDirectoryExists ()
	hasZipExportDirectory ()
	Returns if the export directory for zips exists. More...
	getZipExportDirectory ()
	Return the export directory, where zips are placed. More...
	compressTestArchive ()
	Generate the test archive for download. More...

Data Fields
const	DIR_SEP = '/'
const	HTML_SUBMISSION_FILENAME = 'test_submission.html'
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_OVERVIEW_HTML_FILENAME = 'results_overview_html_v'
const	TEST_OVERVIEW_HTML_POSTFIX = '.html'
const	LOG_DTSGROUP_FORMAT = 'D M j G:i:s T Y'
const	LOG_ADDITION_STRING = ' Adding '
const	LOG_CREATION_STRING = ' Creating '
const	LOG_UPDATE_STRING = ' Updating '
const	LOG_DELETION_STRING = ' Deleting '
const	TEST_LOG_FILENAME = 'test.log'
const	DATA_INDEX_FILENAME = 'data_index.csv'
const	ARCHIVE_LOG = 'archive.log'
const	EXPORT_DIRECTORY = 'archive_exports'

Protected Member Functions
	hasTestArchive ()
	Returns if the archive directory structure for the test the object is created for exists. More...
	createArchiveForTest ()
	Creates the directory for the test archive. More...
	getTestArchive ()
	Returns the (theoretical) path to the archive directory of the test, this object is created for. More...
	ensureTestArchiveIsAvailable ()
	Ensures the availability of the test archive directory. More...
	createZipExportDirectory ()
	hasPassDataDirectory ($active_fi, $pass)
	Checks if the directory for pass data is available. More...
	createPassDataDirectory ($active_fi, $pass)
	Creates pass data directory. More...
	getPassDataDirectory ($active_fi, $pass)
	Returns the pass data directory. More...
	ensurePassDataDirectoryIsAvailable ($active_fi, $pass)
	Ensures the availability of the participant data directory. More...
	hasPassMaterialsDirectory ($active_fi, $pass)
	Returns if the pass materials directory exists for a given pass. More...
	createPassMaterialsDirectory ($active_fi, $pass)
	Creates pass materials directory. More...
	getPassMaterialsDirectory ($active_fi, $pass)
	Returns the pass materials directory. More...
	ensurePassMaterialsDirectoryIsAvailable ($active_fi, $pass)
	Ensures the availability of the pass materials directory. More...
	readArchiveDataIndex ()
	Reads the archive data index. More...
	appendToArchiveDataIndex ($date, $active_fi, $pass, $user_firstname, $user_lastname, $matriculation)
	Appends a line to the archive data index. More...
	determinePassDataPath ($date, $active_fi, $pass, $user_firstname, $user_lastname, $matriculation)
	Determines the pass data path. More...
	logArchivingProcess ($message)
	Logs to the archive log. More...
	countFilesInDirectory ($directory, $pattern=null)
	Returns the count of files in a directory, eventually matching the given, optional, pattern. More...

Protected Attributes
const	TEST_RESULT_FILENAME = 'test_result.html'
	$external_directory_path
	$client_id
	$test_obj_id
	$test_ref_id
	$archive_data_index
ilLanguage	$lng
ilDBInterface	$db
ilCtrl	$ctrl
ilObjUser	$user
ilTabsGUI	$tabs
ilToolbarGUI	$toolbar
ilGlobalTemplateInterface	$tpl
UIFactory	$ui_factory
UIRenderer	$ui_renderer
ilAccess	$access
InternalRequestService	$testrequest
GlobalHttpState	$http
RefineryFactory	$refinery
ilTestHTMLGenerator	$html_generator
	$participantData

Private Member Functions
	buildPassDataDirectory ($active_fi, $pass)

Private Attributes
ILIAS ResourceStorage Services	$irss

Detailed Description

Class ilTestArchiver.

Helper class to deal with the generation and maintenance of test archives.

Author

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

Version

$Id$

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

Member Function Documentation

appendToArchiveDataIndex()

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

protected

Appends a line to the archive data index.

Parameters

$date	string Date for the directories path.
$active_fi	integer ActiveFI of the participant.
$pass	integer Pass number of the participant.
$user_firstname	string User firstname.
$user_lastname	string User lastname.
$matriculation	string Matriculation number of the user.

Returns

void

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

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

Referenced by createPassMaterialsDirectory(), and getPassDataDirectory().

    {
        $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() . self::DIR_SEP . 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 556 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() . self::DIR_SEP . implode(self::DIR_SEP, $data_index_entry);
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

compressTestArchive()

ilTestArchiver::compressTestArchive

(

)

Generate the test archive for download.

Returns

void

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

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

    {
        $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 . self::DIR_SEP . $zip_output_filename, true);
        return;
    }

Here is the call graph for this function:

countFilesInDirectory()

ilTestArchiver::countFilesInDirectory (   $directory,   $pattern = null  )

protected

Returns the count of files in a directory, eventually matching the given, optional, pattern.

Parameters

	$directory
null | string	$pattern

Returns

integer

PhpAssignmentInConditionInspection

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

                                                                         : int
    {
        $filecount = 0;

        if ($handle = opendir($directory)) {
            while (($file = readdir($handle)) !== false) {
                if (!in_array($file, array( '.', '..' )) && !is_dir($directory . $file)) {
                    if ($pattern && strpos($file, $pattern) === 0) {
                        $filecount++;
                    }
                }
            }
        }
        return $filecount;
    }

createArchiveForTest()

ilTestArchiver::createArchiveForTest ( )

protected

Creates the directory for the test archive.

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

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

Referenced by ensureTestArchiveIsAvailable().

    {
        ilFileUtils::makeDirParents($this->getTestArchive());
        //mkdir( $this->getTestArchive(), 0777, true );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createPassDataDirectory()

ilTestArchiver::createPassDataDirectory (   $active_fi,   $pass  )

protected

Creates pass data directory.

Parameters

$active_fi	integer ActiveFI of the participant.
$pass	integer Pass number of the test.

Returns

void

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

References getPassDataDirectory().

Referenced by ensurePassDataDirectoryIsAvailable().

    {
        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 (   $active_fi,   $pass  )

protected

Creates pass materials directory.

Parameters

$active_fi	integer ActiveFI of the participant.
$pass	integer Pass number of the test.

Returns

string

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

References $user, appendToArchiveDataIndex(), ilObjUser\getFirstname(), ilObjUser\getLastname(), ilObjUser\getMatriculation(), getParticipantData(), getPassMaterialsDirectory(), ilObjUser\setFirstname(), ilObjUser\setLastname(), and ilObjUser\setMatriculation().

Referenced by ensurePassMaterialsDirectoryIsAvailable().

                                                                      : string
    {
        // Data are 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.

        $user = $this->user;

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

        $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:

createZipExportDirectory()

ilTestArchiver::createZipExportDirectory ( )

protected

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

References getZipExportDirectory().

Referenced by ensureZipExportDirectoryExists().

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

Here is the call graph for this function:

Here is the caller graph for this function:

determinePassDataPath()

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

protected

Determines the pass data path.

Parameters

$date
$active_fi
$pass
$user_firstname
$user_lastname
$matriculation

Returns

array

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

Referenced by appendToArchiveDataIndex().

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

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

Here is the caller graph for this function:

ensurePassDataDirectoryIsAvailable()

ilTestArchiver::ensurePassDataDirectoryIsAvailable (   $active_fi,   $pass  )

protected

Ensures the availability of the participant data directory.

Checks if the directory exists and creates it if necessary.

Parameters

$active_fi	integer Active-FI of the test participant
$pass	integer Pass-number of the actual test

Returns

void

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

References createPassDataDirectory(), and hasPassDataDirectory().

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

    {
        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 (   $active_fi,   $pass  )

protected

Ensures the availability of the pass materials directory.

Checks if the directory exists and creates it if necessary.

Parameters

$active_fi	integer Active-FI of the test participant
$pass	integer Pass-number of the actual test

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

References createPassMaterialsDirectory(), and hasPassMaterialsDirectory().

Referenced by handInParticipantUploadedResults().

    {
        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

Ensures the availability of the test archive directory.

Checks if the directory exists and creates it if necessary.

Returns

void

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

References createArchiveForTest(), and hasTestArchive().

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

    {
        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 470 of file class.ilTestArchiver.php.

References createZipExportDirectory(), and hasZipExportDirectory().

Referenced by compressTestArchive().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getParticipantData()

ilTestArchiver::getParticipantData

(

)

Returns

ilTestParticipantData

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

References $participantData.

Referenced by createPassMaterialsDirectory(), and getPassDataDirectory().

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

Here is the caller graph for this function:

getPassDataDirectory()

ilTestArchiver::getPassDataDirectory (   $active_fi,   $pass  )

protected

Returns the pass data directory.

Parameters

$active_fi	integer ActiveFI of the participant.
$pass	integer Pass number of the test.

Returns

string $pass_data_directory Path to the pass data directory.

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

References appendToArchiveDataIndex(), buildPassDataDirectory(), getParticipantData(), 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 = 'anonym';
            $lastname = '';
            $matriculation = '0';
        } else {
            if ($this->getParticipantData()) {
                $usr_data = $this->getParticipantData()->getUserDataByActiveId($active_fi);
                $firstname = $usr_data['firstname'];
                $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 (   $active_fi,   $pass  )

protected

Returns the pass materials directory.

Parameters

$active_fi	integer ActiveFI of the participant.
$pass	integer Pass number.

Returns

string $pass_materials_directory Path to the pass materials directory.

Definition at line 699 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 . self::DIR_SEP . self::PASS_MATERIALS_PATH_COMPONENT;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTestArchive()

ilTestArchiver::getTestArchive ( )

protected

Returns the (theoretical) path to the archive directory of the test, this object is created for.

Returns

string $test_archive Path to this tests archive directory.

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

References $test_obj_id.

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

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

Here is the caller graph for this function:

getZipExportDirectory()

ilTestArchiver::getZipExportDirectory

(

)

Return the export directory, where zips are placed.

Returns

string

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

References $test_obj_id.

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

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

Here is the caller graph for this function:

handInBestSolutionQuestionMaterial()

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

Hands in a file related to a question in context of the best solution.

Parameters

$question_fi	integer QuestionFI of the question, material is to be stored for.
$orginial_filename	string Original filename of the material to be stored.
$file_path	string Path to the material to be stored.

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

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

    {
        $this->ensureTestArchiveIsAvailable();

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

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

        $question_materials_path = $materials_path . self::DIR_SEP . 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 . self::DIR_SEP . $orginial_filename);

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

Here is the call graph for this function:

handInParticipantMisc()

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

Hands in a participants file, which is relevant for archiving but an unspecified type.

Examples for such are signature files, remarks, feedback or the like.

Parameters

$active_fi	integer Active-FI of the test participant
$pass	integer Pass-number of the actual test
$original_filename	string Original filename of the material to be stored.
$file_path	string Location of the file to be archived

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

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

    {
        $this->ensureTestArchiveIsAvailable();
        $this->ensurePassDataDirectoryIsAvailable($active_fi, $pass);
        $new_path = $this->getPassDataDirectory($active_fi, $pass) . self::DIR_SEP . $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	(		$active_fi,
			$pass,
			$question_fi,
			$original_filename,
			$file_path
	)

Hands in a particpants question material, such as an upload or other binary content.

Parameters

$active_fi	integer Active-FI of the test participant
$pass	integer Pass-number of the actual test
$question_fi	integer Question-FI of the question, the file is to be stored for.
$original_filename	string Original filename of the material to be stored.
$file_path	string Location of the file to be archived

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

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

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

        $pass_question_directory = $this->getPassDataDirectory($active_fi, $pass)
            . self::DIR_SEP . 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 . self::DIR_SEP . $original_filename);

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

Here is the call graph for this function:

handInParticipantUploadedResults()

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

Parameters

$active_fi
$pass

Returns

void

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

References CLIENT_WEB_DIR, ensurePassDataDirectoryIsAvailable(), ensurePassMaterialsDirectoryIsAvailable(), ensureTestArchiveIsAvailable(), getPassMaterialsDirectory(), and logArchivingProcess().

                                                                                 {
        $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 . self::DIR_SEP . $question->question_id . self::DIR_SEP;
                if (!file_exists($archive_folder)) {
                    mkdir($archive_folder, 0777, true);
                }
                // TODO old Filesystem remove on ILIAS 10
                $local_folder = CLIENT_WEB_DIR . '/assessment/tst_' . $tst_obj->test_id . self::DIR_SEP . $active_fi . self::DIR_SEP . $question->question_id . '/files/';
                if (file_exists($local_folder)) {
                    $folder_content = scandir($local_folder);
                    $folder_content = array_diff($folder_content, array('.', '..'));
                    foreach ($folder_content as $file_name) {
                        if (preg_match('/file_(\d+)_(\d+)_(\d+)/', $file_name, $matches)){
                            if ($active_fi == intval($matches[1]) && $pass == $matches[2]){
                                $local_file= $local_folder . $file_name;
                                $target_destination = $archive_folder . $file_name;
                                copy($local_file, $target_destination);
                                $this->logArchivingProcess(date(self::LOG_DTSGROUP_FORMAT) . self::LOG_ADDITION_STRING . $target_destination);
                            }
                        }
                    }
                }
                // IRSS
                $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

(

$best_solution

)

Hands in the best solution for a test.

Parameters

$html_string	string HTML-string of the test submission
$pdf_path	string Path to a pdf representation of the test submission.

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

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

    {
        $this->ensureTestArchiveIsAvailable();

        $best_solution_path = $this->getTestArchive() . self::DIR_SEP . 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 . self::DIR_SEP . self::HTML_BEST_SOLUTION_FILENAME
        );

        $this->logArchivingProcess(
            date(self::LOG_DTSGROUP_FORMAT) . self::LOG_ADDITION_STRING
            . $best_solution_path . self::DIR_SEP . 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	(		$active_fi,
			$pass,
			$pdf_path
	)

Hands in an individual test result for a pass.

Parameters

$active_fi	integer ActiveFI of the participant.
$pass	integer Pass of the test.
$pdf_path	string Path to the PDF containing the result.

Returns

void

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

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

    {
        $this->ensureTestArchiveIsAvailable();
        $this->ensurePassDataDirectoryIsAvailable($active_fi, $pass);
        $new_path = $this->getPassDataDirectory($active_fi, $pass) . self::DIR_SEP . 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 (   $active_fi,   $pass  )

protected

Checks if the directory for pass data is available.

Parameters

$active_fi	integer ActiveFI of the pass.
$pass	integer Pass-number of the pass.

Returns

bool $hasPassDataDirectory True, if the pass data directory exists.

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

References getPassDataDirectory().

Referenced by ensurePassDataDirectoryIsAvailable().

                                                              : bool
    {
        $pass_data_dir = $this->getPassDataDirectory($active_fi, $pass);
        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 (   $active_fi,   $pass  )

protected

Returns if the pass materials directory exists for a given pass.

Parameters

$active_fi	integer ActiveFI for the participant.
$pass	integer Pass number.

Returns

bool $hasPassmaterialsDirectory True, if the directory exists.

PhpUsageOfSilenceOperatorInspection

Definition at line 645 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

Returns if the archive directory structure for the test the object is created for exists.

Returns

bool $hasTestArchive True, if the archive directory structure exists.

Definition at line 373 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

(

)

Returns if the export directory for zips exists.

Returns

bool

Definition at line 482 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 (   $message )

protected

Logs to the archive log.

Parameters

$message

string Complete log message.

Returns

void

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

References $message, and getTestArchive().

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

    {
        $archive = $this->getTestArchive() . self::DIR_SEP . 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

Reads the archive data index.

Returns

array[array] $archive_data_index Archive data index.

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

PhpUsageOfSilenceOperatorInspection

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

References getTestArchive().

Referenced by appendToArchiveDataIndex().

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

        $contents = array();

        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

(

$participantData

)

Parameters

ilTestParticipantData

$participantData

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

References $participantData.

Referenced by ilTestArchiveService\archiveActivesPass().

    {
        $this->participantData = $participantData;
    }

Here is the caller graph for this function:

updateTestArchive()

ilTestArchiver::updateTestArchive

(

)

Replaces the test-log with the current one.

Returns

void

PhpAssignmentInConditionInspection

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

References $filename, ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getTestArchive(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by compressTestArchive().

    {
        $query = 'SELECT * FROM ass_log WHERE obj_fi = ' . $this->db->quote($this->test_obj_id, 'integer');
        $result = $this->db->query($query);

        $outfile_lines = '';
        while ($row = $this->db->fetchAssoc($result)) {
            $outfile_lines .= "\r\n" . implode("\t", $row);
        }
        file_put_contents($this->getTestArchive() . self::DIR_SEP . self::TEST_LOG_FILENAME, $outfile_lines);

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

        $gui = new ilParticipantsTestResultsGUI(
            $this->ctrl,
            $this->lng,
            $this->db,
            $this->user,
            $this->tabs,
            $this->toolbar,
            $this->tpl,
            $this->ui_factory,
            $this->ui_renderer,
            new ilTestParticipantAccessFilterFactory($this->access),
            $this->testrequest,
            $this->http,
            $this->refinery
        );
        $gui->setTestObj($test);

        $objectiveOrientedContainer = new ilTestObjectiveOrientedContainer();
        $gui->setObjectiveParent($objectiveOrientedContainer);
        $array_of_actives = array();
        $participants = $test->getParticipants();

        foreach ($participants as $key => $value) {
            $array_of_actives[] = $key;
        }
        $output_template = $gui->createUserResults(true, false, true, $array_of_actives);

        $filename = realpath($this->getTestArchive()) . self::DIR_SEP . 'participant_pass_overview.html';
        $this->html_generator->generateHTML($output_template->get(), $filename);

        return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccess ilTestArchiver::$access

protected

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

$archive_data_index

ilTestArchiver::$archive_data_index

protected

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

$client_id

ilTestArchiver::$client_id

protected

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

$ctrl

ilCtrl ilTestArchiver::$ctrl

protected

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

$db

ilDBInterface ilTestArchiver::$db

protected

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

$external_directory_path

ilTestArchiver::$external_directory_path

protected

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

$html_generator

ilTestHTMLGenerator ilTestArchiver::$html_generator

protected

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

$http

GlobalHttpState ilTestArchiver::$http

protected

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

$irss

ILIAS ResourceStorage Services ilTestArchiver::$irss

private

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

$lng

ilLanguage ilTestArchiver::$lng

protected

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

$participantData

ilTestArchiver::$participantData

protected

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

Referenced by getParticipantData(), and setParticipantData().

$refinery

RefineryFactory ilTestArchiver::$refinery

protected

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

$tabs

ilTabsGUI ilTestArchiver::$tabs

protected

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

$test_obj_id

ilTestArchiver::$test_obj_id

protected

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

Referenced by getTestArchive(), and getZipExportDirectory().

$test_ref_id

ilTestArchiver::$test_ref_id

protected

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

$testrequest

InternalRequestService ilTestArchiver::$testrequest

protected

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

$toolbar

ilToolbarGUI ilTestArchiver::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilTestArchiver::$tpl

protected

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

$ui_factory

UIFactory ilTestArchiver::$ui_factory

protected

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

$ui_renderer

UIRenderer ilTestArchiver::$ui_renderer

protected

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

$user

ilObjUser ilTestArchiver::$user

protected

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

Referenced by createPassMaterialsDirectory().

ARCHIVE_LOG

const ilTestArchiver::ARCHIVE_LOG = 'archive.log'

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

DATA_INDEX_FILENAME

const ilTestArchiver::DATA_INDEX_FILENAME = 'data_index.csv'

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

DIR_SEP

const ilTestArchiver::DIR_SEP = '/'

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

EXPORT_DIRECTORY

const ilTestArchiver::EXPORT_DIRECTORY = 'archive_exports'

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

HTML_BEST_SOLUTION_FILENAME

const ilTestArchiver::HTML_BEST_SOLUTION_FILENAME = 'best_solution.html'

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

HTML_SUBMISSION_FILENAME

const ilTestArchiver::HTML_SUBMISSION_FILENAME = 'test_submission.html'

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

LOG_ADDITION_STRING

const ilTestArchiver::LOG_ADDITION_STRING = ' Adding '

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

LOG_CREATION_STRING

const ilTestArchiver::LOG_CREATION_STRING = ' Creating '

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

LOG_DELETION_STRING

const ilTestArchiver::LOG_DELETION_STRING = ' Deleting '

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

LOG_DTSGROUP_FORMAT

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

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

LOG_UPDATE_STRING

const ilTestArchiver::LOG_UPDATE_STRING = ' Updating '

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

PASS_MATERIALS_PATH_COMPONENT

const ilTestArchiver::PASS_MATERIALS_PATH_COMPONENT = 'materials'

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

QUESTION_PATH_COMPONENT_PREFIX

const ilTestArchiver::QUESTION_PATH_COMPONENT_PREFIX = 'q_'

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

TEST_BEST_SOLUTION_PATH_COMPONENT

const ilTestArchiver::TEST_BEST_SOLUTION_PATH_COMPONENT = 'best_solution'

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

TEST_LOG_FILENAME

const ilTestArchiver::TEST_LOG_FILENAME = 'test.log'

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

TEST_MATERIALS_PATH_COMPONENT

const ilTestArchiver::TEST_MATERIALS_PATH_COMPONENT = 'materials'

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

TEST_OVERVIEW_HTML_FILENAME

const ilTestArchiver::TEST_OVERVIEW_HTML_FILENAME = 'results_overview_html_v'

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

TEST_OVERVIEW_HTML_POSTFIX

const ilTestArchiver::TEST_OVERVIEW_HTML_POSTFIX = '.html'

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

TEST_RESULT_FILENAME

const ilTestArchiver::TEST_RESULT_FILENAME = 'test_result.html'

protected

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

---

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

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