Collaboration diagram for ilAssFileUploadUploadsExporter:

Public Member Functions
	__construct (private ilDBInterface $db, private ilLanguage $lng, private int $ref_id, private int $test_id,)

	getRefId ()

	getTestId ()

	getTestTitle ()

	setTestTitle (string $test_title)

	getQuestion ()

	setQuestion ($question)

	buildAndDownload ()

	getFinalZipFilePath ()

	getDispoZipFileName ()

	getZipFileMimeType ()

Data Fields
const	ZIP_FILE_MIME_TYPE = 'application/zip'

const	ZIP_FILE_EXTENSION = '.zip'

Private Member Functions
	initFilenames ()

	getFileUploadSolutionData ()

	getParticipantData ($solutionData)

	collectUploadedFiles (array $solution_data, ilTestParticipantData $participant_data)

	getPassSubDirName ($pass)

	createFileUploadCollectionZipFile ()

Private Attributes
Closure	$access_filter

ILIAS ResourceStorage Services	$irss

ILIAS Filesystem Util Archive Archives	$archive

ILIAS FileDelivery Services	$file_delivery

	$test_title

	$question

	$finalZipFilePath

	$tempZipFilePath

	$tempDirPath

	$mainFolderName

Detailed Description

Definition at line 27 of file class.ilAssFileUploadUploadsExporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssFileUploadUploadsExporter::__construct	(	private ilDBInterface	$db,
		private ilLanguage	$lng,
		private int	$ref_id,
		private int	$test_id
	)

Parameters

ilDBInterface $db

Definition at line 69 of file class.ilAssFileUploadUploadsExporter.php.

      {
        global $DIC;
        $f = new ilTestParticipantAccessFilterFactory($DIC->access());
        $this->access_filter = $f->getAccessStatisticsUserFilter($this->ref_id);
 
        $this->irss = $DIC->resourceStorage();
        $this->archive = $DIC->archives();
        $this->file_delivery = $DIC->fileDelivery();
    }

References $DIC, and Vendor\Package\$f.

Member Function Documentation

◆ buildAndDownload()

ilAssFileUploadUploadsExporter::buildAndDownload ( )

Definition at line 126 of file class.ilAssFileUploadUploadsExporter.php.

                                      : void
    {
        $solution_data = $this->getFileUploadSolutionData();
 
        $participant_data = $this->getParticipantData($solution_data);
 
        $this->collectUploadedFiles($solution_data, $participant_data);
    }

References collectUploadedFiles(), getFileUploadSolutionData(), and getParticipantData().

Here is the call graph for this function:

◆ collectUploadedFiles()

ilAssFileUploadUploadsExporter::collectUploadedFiles	(	array	$solution_data,
		ilTestParticipantData	$participant_data
	)

private

Definition at line 198 of file class.ilAssFileUploadUploadsExporter.php.

                                                                                                        : void
    {
        $streams = [];
 
        foreach ($solution_data as $activeId => $passes) {
            if (!in_array($activeId, $participant_data->getActiveIds(), true)) {
                continue;
            }
 
            foreach ($passes as $pass => $files) {
                foreach ($files as $file) {
                    // path inside zip
                    $dir = $this->mainFolderName;
                    $dir .= $participant_data->getFileSystemCompliantFullnameByActiveId($activeId) . '/';
                    $dir .= $this->getPassSubDirName($file['pass']) . '/';
 
                    // IRSS Version
                    if ($file['value2'] === 'rid') {
                        $revision = $this->irss->manage()->getCurrentRevision(
                            $rid = $this->irss->manage()->find($file['value1'])
                        );
                        $streams[$dir . $revision->getTitle()] = $this->irss->consume()->stream($rid)->getStream();
                        continue;
                    }
 
                    // Legacy Version
                    $file_dir = $this->question->getFileUploadPath(
                        $this->getTestId(),
                        $activeId,
                        $this->question->getId()
                    );
 
                    $legacy_file_path = $file_dir . $file['value1'];
                    if (!is_file($legacy_file_path)) {
                        continue;
                    }
 
                    $streams[$dir . $file['value2']] = Streams::ofResource(fopen($legacy_file_path, 'rb'));
                }
            }
        }
 
        $zip = $this->archive->zip($streams);
 
        $this->file_delivery->delivery()->attached(
            $zip->get(),
            $this->getDispoZipFileName(),
            'application/zip'
        );
    }

References $mainFolderName, ilTestParticipantData\getActiveIds(), ilTestParticipantData\getFileSystemCompliantFullnameByActiveId(), getPassSubDirName(), and getTestId().

Referenced by buildAndDownload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFileUploadCollectionZipFile()

ilAssFileUploadUploadsExporter::createFileUploadCollectionZipFile ( )

private

Definition at line 254 of file class.ilAssFileUploadUploadsExporter.php.

                                                        : void
    {
        ilFileUtils::zip($this->tempDirPath . '/' . $this->mainFolderName, $this->tempZipFilePath);
 
        $pathinfo = pathinfo($this->tempZipFilePath);
        $this->finalZipFilePath = dirname($pathinfo['dirname']) . '/' . $pathinfo['basename'];
 
        try {
            ilFileUtils::rename($this->tempZipFilePath, $this->finalZipFilePath);
        } catch (\ilFileUtilsException $e) {
            \ilLoggerFactory::getRootLogger()->error($e->getMessage());
        }
    }

References Vendor\Package\$e, ilLoggerFactory\getRootLogger(), ilFileUtils\rename(), and ilFileUtils\zip().

Here is the call graph for this function:

◆ getDispoZipFileName()

ilAssFileUploadUploadsExporter::getDispoZipFileName ( )

Definition at line 273 of file class.ilAssFileUploadUploadsExporter.php.

                                         : string
    {
        return ilFileUtils::getASCIIFilename(
            $this->test_title . '_' . $this->question->getTitle() . self::ZIP_FILE_EXTENSION
        );
    }

References ilFileUtils\getASCIIFilename().

Here is the call graph for this function:

◆ getFileUploadSolutionData()

ilAssFileUploadUploadsExporter::getFileUploadSolutionData ( )

private

Definition at line 146 of file class.ilAssFileUploadUploadsExporter.php.

                                                : array
    {
        $query = "
                        SELECT tst_solutions.solution_id, tst_solutions.pass, tst_solutions.active_fi, tst_solutions.question_fi,
                                tst_solutions.value1, tst_solutions.value2, tst_solutions.tstamp
                        FROM tst_solutions, tst_active, qpl_questions
                        WHERE tst_solutions.active_fi = tst_active.active_id
                        AND tst_solutions.question_fi = qpl_questions.question_id
                        AND tst_solutions.question_fi = %s
                        AND tst_active.test_fi = %s
                        ORDER BY tst_solutions.active_fi, tst_solutions.tstamp
                ";
 
        $res = $this->db->queryF(
            $query,
            ["integer", "integer"],
            [$this->question->getId(), $this->getTestId()]
        );
 
        $solutionData = [];
 
        while ($row = $this->db->fetchAssoc($res)) {
            if (!isset($solutionData[$row['active_fi']])) {
                $solutionData[ $row['active_fi'] ] = [];
            }
 
            if (!isset($solutionData[ $row['active_fi'] ][ $row['pass'] ])) {
                $solutionData[ $row['active_fi'] ][ $row['pass'] ] = [];
            }
 
            $solutionData[ $row['active_fi'] ][ $row['pass'] ][] = $row;
        }
 
        return $solutionData;
    }

References $res.

Referenced by buildAndDownload().

Here is the caller graph for this function:

◆ getFinalZipFilePath()

ilAssFileUploadUploadsExporter::getFinalZipFilePath ( )

Definition at line 268 of file class.ilAssFileUploadUploadsExporter.php.

                                         : string
    {
        return $this->finalZipFilePath;
    }

References $finalZipFilePath.

◆ getParticipantData()

ilAssFileUploadUploadsExporter::getParticipantData ( $solutionData )

private

Definition at line 182 of file class.ilAssFileUploadUploadsExporter.php.

                                                      : ilTestParticipantData
    {
        $activeIds = [];
 
        foreach ($solutionData as $activeId => $passes) {
            $activeIds[] = $activeId;
        }
 
        $participantData = new ilTestParticipantData($this->db, $this->lng);
        $participantData->setActiveIdsFilter($activeIds);
        $participantData->setParticipantAccessFilter($this->access_filter);
        $participantData->load($this->getTestId());
 
        return $participantData;
    }

References getTestId(), and ILIAS\Repository\lng().

Referenced by buildAndDownload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPassSubDirName()

ilAssFileUploadUploadsExporter::getPassSubDirName ( $pass )

private

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

                                             : string
    {
        return $this->lng->txt('pass') . '_' . ($pass + 1);
    }

References ILIAS\Repository\lng().

Referenced by collectUploadedFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestion()

ilAssFileUploadUploadsExporter::getQuestion ( )

Returns: ilObjFileHandlingQuestionType

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

                                 : ilObjFileHandlingQuestionType
    {
        return $this->question;
    }

References $question.

◆ getRefId()

ilAssFileUploadUploadsExporter::getRefId ( )

Definition at line 84 of file class.ilAssFileUploadUploadsExporter.php.

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

◆ getTestId()

ilAssFileUploadUploadsExporter::getTestId ( )

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

                               : int
    {
        return $this->test_id;
    }

Referenced by collectUploadedFiles(), and getParticipantData().

Here is the caller graph for this function:

◆ getTestTitle()

ilAssFileUploadUploadsExporter::getTestTitle ( )

Returns: string

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

                                  : string
    {
        return $this->test_title;
    }

References $test_title.

Referenced by initFilenames().

Here is the caller graph for this function:

◆ getZipFileMimeType()

ilAssFileUploadUploadsExporter::getZipFileMimeType ( )

Definition at line 280 of file class.ilAssFileUploadUploadsExporter.php.

                                        : string
    {
        return self::ZIP_FILE_MIME_TYPE;
    }

References ZIP_FILE_MIME_TYPE.

◆ initFilenames()

ilAssFileUploadUploadsExporter::initFilenames ( )

private

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

                                    : void
    {
        $this->tempDirPath = ilFileUtils::ilTempnam();
 
        $this->tempZipFilePath = ilFileUtils::ilTempnam($this->tempDirPath) . self::ZIP_FILE_EXTENSION;
 
        $this->mainFolderName = ilFileUtils::getASCIIFilename(
            str_replace(' ', '', $this->getTestTitle() . '_' . $this->question->getTitle())
        );
    }

References ilFileUtils\getASCIIFilename(), getTestTitle(), ilFileUtils\ilTempnam(), and ZIP_FILE_EXTENSION.

Here is the call graph for this function:

◆ setQuestion()

ilAssFileUploadUploadsExporter::setQuestion ( $question )

Parameters

ilObjFileHandlingQuestionType $question

Definition at line 121 of file class.ilAssFileUploadUploadsExporter.php.

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

References $question.

◆ setTestTitle()

ilAssFileUploadUploadsExporter::setTestTitle ( string $test_title )

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

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

References $test_title.

Field Documentation

◆ $access_filter

Closure ilAssFileUploadUploadsExporter::$access_filter

private

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

◆ $archive

ILIAS Filesystem Util Archive Archives ilAssFileUploadUploadsExporter::$archive

private

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

◆ $file_delivery

ILIAS FileDelivery Services ilAssFileUploadUploadsExporter::$file_delivery

private

Definition at line 34 of file class.ilAssFileUploadUploadsExporter.php.

◆ $finalZipFilePath

ilAssFileUploadUploadsExporter::$finalZipFilePath

private

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

Referenced by getFinalZipFilePath().

◆ $irss

ILIAS ResourceStorage Services ilAssFileUploadUploadsExporter::$irss

private

Definition at line 32 of file class.ilAssFileUploadUploadsExporter.php.

◆ $mainFolderName

ilAssFileUploadUploadsExporter::$mainFolderName

private

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

Referenced by collectUploadedFiles().

◆ $question

ilAssFileUploadUploadsExporter::$question

private

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

Referenced by getQuestion(), and setQuestion().

◆ $tempDirPath

ilAssFileUploadUploadsExporter::$tempDirPath

private

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

◆ $tempZipFilePath

ilAssFileUploadUploadsExporter::$tempZipFilePath

private

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

◆ $test_title

ilAssFileUploadUploadsExporter::$test_title

private

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

Referenced by getTestTitle(), and setTestTitle().

◆ ZIP_FILE_EXTENSION

const ilAssFileUploadUploadsExporter::ZIP_FILE_EXTENSION = '.zip'

Definition at line 30 of file class.ilAssFileUploadUploadsExporter.php.

Referenced by initFilenames().

◆ ZIP_FILE_MIME_TYPE

const ilAssFileUploadUploadsExporter::ZIP_FILE_MIME_TYPE = 'application/zip'

Definition at line 29 of file class.ilAssFileUploadUploadsExporter.php.

Referenced by getZipFileMimeType().

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

components/ILIAS/TestQuestionPool/classes/class.ilAssFileUploadUploadsExporter.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildAndDownload()

◆ collectUploadedFiles()

◆ createFileUploadCollectionZipFile()

◆ getDispoZipFileName()

◆ getFileUploadSolutionData()

◆ getFinalZipFilePath()

◆ getParticipantData()

◆ getPassSubDirName()

◆ getQuestion()

◆ getRefId()

◆ getTestId()

◆ getTestTitle()

◆ getZipFileMimeType()

◆ initFilenames()

◆ setQuestion()

◆ setTestTitle()

Field Documentation

◆ $access_filter

◆ $archive

◆ $file_delivery

◆ $finalZipFilePath

◆ $irss

◆ $mainFolderName

◆ $question

◆ $tempDirPath

◆ $tempZipFilePath

◆ $test_title

◆ ZIP_FILE_EXTENSION

◆ ZIP_FILE_MIME_TYPE