Collaboration diagram for ilAssFileUploadUploadsExporter:

Public Member Functions
	__construct (ilDBInterface $db, ilLanguage $lng)

	getTestId ()

	setTestId ($testId)

	getTestTitle ()

	setTestTitle ($testTitle)

	getQuestion ()

	setQuestion ($question)

	build ()

	getFinalZipFilePath ()

	getDispoZipFileName ()

	getZipFileMimeType ()

Data Fields
const	ZIP_FILE_MIME_TYPE = 'application/zip'

const	ZIP_FILE_EXTENSION = '.zip'

Protected Attributes
	$db

	$lng

Private Member Functions
	initFilenames ()

	getFileUploadSolutionData ()

	getParticipantData ($solutionData)

	collectUploadedFiles ($solutionData, ilTestParticipantData $participantData)

	getPassSubDirName ($pass)

	createFileUploadCollectionZipFile ()

	removeFileUploadCollection ()

Private Attributes
	$testId

	$testTitle

	$question

	$finalZipFilePath

	$tempZipFilePath

	$tempDirPath

	$mainFolderName

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilAssFileUploadUploadsExporter::__construct	(	ilDBInterface	$db,
		ilLanguage	$lng
	)

Parameters

ilDBInterface $db

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

    {
        $this->db = $db;
        $this->lng = $lng;
    }

References $db, and $lng.

Member Function Documentation

◆ build()

ilAssFileUploadUploadsExporter::build ( )

Returns: string

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

    {
        $this->initFilenames();
        
        $solutionData = $this->getFileUploadSolutionData();
        
        $participantData = $this->getParticipantData($solutionData);
        
        $this->collectUploadedFiles($solutionData, $participantData);
 
        $this->createFileUploadCollectionZipFile();
 
        $this->removeFileUploadCollection();
    }

References collectUploadedFiles(), createFileUploadCollectionZipFile(), getFileUploadSolutionData(), getParticipantData(), initFilenames(), and removeFileUploadCollection().

Here is the call graph for this function:

◆ collectUploadedFiles()

ilAssFileUploadUploadsExporter::collectUploadedFiles	(		$solutionData,
		ilTestParticipantData	$participantData
	)

private

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

    {
        foreach ($solutionData as $activeId => $passes) {
            foreach ($passes as $pass => $files) {
                foreach ($files as $file) {
                    $uploadedFileDir = $this->question->getFileUploadPath(
                        $this->getTestId(),
                        $activeId,
                        $this->question->getId()
                    );
 
                    // #20317
                    if (!is_file($uploadedFileDir . $file['value1'])) {
                        continue;
                    }
 
                    $destinationDir = $this->tempDirPath . '/' . $this->mainFolderName . '/';
                    $destinationDir .= $participantData->getFileSystemCompliantFullnameByActiveId($activeId) . '/';
                    $destinationDir .= $this->getPassSubDirName($file['pass']) . '/';
                        
                    ilUtil::makeDirParents($destinationDir);
 
                    copy($uploadedFileDir . $file['value1'], $destinationDir . $file['value2']);
                }
            }
        }
    }

References $file, $files, $pass, ilTestParticipantData\getFileSystemCompliantFullnameByActiveId(), getPassSubDirName(), getTestId(), and ilUtil\makeDirParents().

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFileUploadCollectionZipFile()

ilAssFileUploadUploadsExporter::createFileUploadCollectionZipFile ( )

private

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

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

References ilLoggerFactory\getRootLogger(), ilFileUtils\rename(), and ilUtil\zip().

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDispoZipFileName()

ilAssFileUploadUploadsExporter::getDispoZipFileName ( )

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

    {
        return ilUtil::getASCIIFilename(
            $this->mainFolderName . self::ZIP_FILE_EXTENSION
        );
    }

References ilUtil\getASCIIFilename().

Here is the call graph for this function:

◆ getFileUploadSolutionData()

ilAssFileUploadUploadsExporter::getFileUploadSolutionData ( )

private

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

    {
        $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,
            array("integer", "integer"),
            array($this->question->getId(), $this->getTestId())
        );
 
        $solutionData = array();
        
        while ($row = $this->db->fetchAssoc($res)) {
            if (!isset($solutionData[$row['active_fi']])) {
                $solutionData[ $row['active_fi'] ] = array();
            }
 
            if (!isset($solutionData[ $row['active_fi'] ][ $row['pass'] ])) {
                $solutionData[ $row['active_fi'] ][ $row['pass'] ] = array();
            }
 
            $solutionData[ $row['active_fi'] ][ $row['pass'] ][] = $row;
        }
        
        return $solutionData;
    }

References $query, $res, and $row.

Referenced by build().

Here is the caller graph for this function:

◆ getFinalZipFilePath()

ilAssFileUploadUploadsExporter::getFinalZipFilePath ( )

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

    {
        return $this->finalZipFilePath;
    }

References $finalZipFilePath.

◆ getParticipantData()

ilAssFileUploadUploadsExporter::getParticipantData ( $solutionData )

private

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

    {
        $activeIds = array();
            
        foreach ($solutionData as $activeId => $passes) {
            $activeIds[] = $activeId;
        }
 
        require_once 'Modules/Test/classes/class.ilTestParticipantData.php';
        $participantData = new ilTestParticipantData($this->db, $this->lng);
        $participantData->setActiveIds($activeIds);
        $participantData->load($this->getTestId());
        
        return $participantData;
    }

References getTestId().

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPassSubDirName()

ilAssFileUploadUploadsExporter::getPassSubDirName ( $pass )

private

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

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

References $pass.

Referenced by collectUploadedFiles().

Here is the caller graph for this function:

◆ getQuestion()

ilAssFileUploadUploadsExporter::getQuestion ( )

Returns: ilObjFileHandlingQuestionType

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

    {
        return $this->question;
    }

References $question.

◆ getTestId()

ilAssFileUploadUploadsExporter::getTestId ( )

Returns: int

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

    {
        return $this->testId;
    }

References $testId.

Referenced by collectUploadedFiles(), and getParticipantData().

Here is the caller graph for this function:

◆ getTestTitle()

ilAssFileUploadUploadsExporter::getTestTitle ( )

Returns: string

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

    {
        return $this->testTitle;
    }

References $testTitle.

Referenced by initFilenames().

Here is the caller graph for this function:

◆ getZipFileMimeType()

ilAssFileUploadUploadsExporter::getZipFileMimeType ( )

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

    {
        return self::ZIP_FILE_MIME_TYPE;
    }

References ZIP_FILE_MIME_TYPE.

◆ initFilenames()

ilAssFileUploadUploadsExporter::initFilenames ( )

private

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

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

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

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFileUploadCollection()

ilAssFileUploadUploadsExporter::removeFileUploadCollection ( )

private

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

    {
        ilUtil::delDir($this->tempDirPath);
    }

References ilUtil\delDir().

Referenced by build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setQuestion()

ilAssFileUploadUploadsExporter::setQuestion ( $question )

Parameters

ilObjFileHandlingQuestionType $question

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

    {
        $this->question = $question;
    }

References $question.

◆ setTestId()

ilAssFileUploadUploadsExporter::setTestId ( $testId )

Parameters

int $testId

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

    {
        $this->testId = $testId;
    }

References $testId.

◆ setTestTitle()

ilAssFileUploadUploadsExporter::setTestTitle ( $testTitle )

Parameters

string $testTitle

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

    {
        $this->testTitle = $testTitle;
    }

References $testTitle.

Field Documentation

◆ $db

ilAssFileUploadUploadsExporter::$db

protected

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

Referenced by __construct().

◆ $finalZipFilePath

ilAssFileUploadUploadsExporter::$finalZipFilePath

private

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

Referenced by getFinalZipFilePath().

◆ $lng

ilAssFileUploadUploadsExporter::$lng

protected

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

Referenced by __construct().

◆ $mainFolderName

ilAssFileUploadUploadsExporter::$mainFolderName

private

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

◆ $question

ilAssFileUploadUploadsExporter::$question

private

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

Referenced by getQuestion(), and setQuestion().

◆ $tempDirPath

ilAssFileUploadUploadsExporter::$tempDirPath

private

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

◆ $tempZipFilePath

ilAssFileUploadUploadsExporter::$tempZipFilePath

private

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

◆ $testId

ilAssFileUploadUploadsExporter::$testId

private

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

Referenced by getTestId(), and setTestId().

◆ $testTitle

ilAssFileUploadUploadsExporter::$testTitle

private

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

Referenced by getTestTitle(), and setTestTitle().

◆ ZIP_FILE_EXTENSION

const ilAssFileUploadUploadsExporter::ZIP_FILE_EXTENSION = '.zip'

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

Referenced by initFilenames().

◆ ZIP_FILE_MIME_TYPE

const ilAssFileUploadUploadsExporter::ZIP_FILE_MIME_TYPE = 'application/zip'

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

Referenced by getZipFileMimeType().

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

Modules/TestQuestionPool/classes/class.ilAssFileUploadUploadsExporter.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ build()

◆ collectUploadedFiles()

◆ createFileUploadCollectionZipFile()

◆ getDispoZipFileName()

◆ getFileUploadSolutionData()

◆ getFinalZipFilePath()

◆ getParticipantData()

◆ getPassSubDirName()

◆ getQuestion()

◆ getTestId()

◆ getTestTitle()

◆ getZipFileMimeType()

◆ initFilenames()

◆ removeFileUploadCollection()

◆ setQuestion()

◆ setTestId()

◆ setTestTitle()

Field Documentation

◆ $db

◆ $finalZipFilePath

◆ $lng

◆ $mainFolderName

◆ $question

◆ $tempDirPath

◆ $tempZipFilePath

◆ $testId

◆ $testTitle

◆ ZIP_FILE_EXTENSION

◆ ZIP_FILE_MIME_TYPE