ilAssFileUploadUploadsExporter Class Reference

Collaboration diagram for ilAssFileUploadUploadsExporter:

Public Member Functions
	__construct (ilDBInterface $db, ilLanguage $lng)
	getRefId ()
	setRefId ($refId)
	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
	$refId

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 25 of file class.ilAssFileUploadUploadsExporter.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

ilDBInterface

$db

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

References $db, $lng, and ILIAS\Repository\lng().

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

Here is the call graph for this function:

Member Function Documentation

build()

ilAssFileUploadUploadsExporter::build

(

)

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

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

                           : void
    {
        $this->initFilenames();

        $solutionData = $this->getFileUploadSolutionData();

        $participantData = $this->getParticipantData($solutionData);

        $this->collectUploadedFiles($solutionData, $participantData);

        $this->createFileUploadCollectionZipFile();

        $this->removeFileUploadCollection();
    }

Here is the call graph for this function:

collectUploadedFiles()

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

private

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

References ilTestParticipantData\getActiveIds(), ilTestParticipantData\getFileSystemCompliantFullnameByActiveId(), getPassSubDirName(), getTestId(), and ilFileUtils\makeDirParents().

Referenced by build().

                                                                                                : void
    {
        foreach ($solutionData as $activeId => $passes) {
            if (!in_array($activeId, $participantData->getActiveIds())) {
                continue;
            }

            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']) . '/';

                    ilFileUtils::makeDirParents($destinationDir);

                    copy($uploadedFileDir . $file['value1'], $destinationDir . $file['value2']);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createFileUploadCollectionZipFile()

ilAssFileUploadUploadsExporter::createFileUploadCollectionZipFile ( )

private

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

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

Referenced by build().

                                                        : 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());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDispoZipFileName()

ilAssFileUploadUploadsExporter::getDispoZipFileName

(

)

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

References ilFileUtils\getASCIIFilename().

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

Here is the call graph for this function:

getFileUploadSolutionData()

ilAssFileUploadUploadsExporter::getFileUploadSolutionData ( )

private

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

References $query, $res, and getTestId().

Referenced by build().

                                                : 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,
            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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFinalZipFilePath()

ilAssFileUploadUploadsExporter::getFinalZipFilePath

(

)

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

References $finalZipFilePath.

                                         : string
    {
        return $this->finalZipFilePath;
    }

getParticipantData()

ilAssFileUploadUploadsExporter::getParticipantData (   $solutionData )

private

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

References ilTestParticipantAccessFilter\getAccessStatisticsUserFilter(), getRefId(), getTestId(), and ILIAS\Repository\lng().

Referenced by build().

                                                      : ilTestParticipantData
    {
        $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->setActiveIdsFilter($activeIds);
        $participantData->setParticipantAccessFilter(
            ilTestParticipantAccessFilter::getAccessStatisticsUserFilter($this->getRefId())
        );
        $participantData->load($this->getTestId());

        return $participantData;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPassSubDirName()

ilAssFileUploadUploadsExporter::getPassSubDirName (   $pass )

private

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

References ILIAS\Repository\lng().

Referenced by collectUploadedFiles().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getQuestion()

ilAssFileUploadUploadsExporter::getQuestion

(

)

Returns

ilObjFileHandlingQuestionType

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

References $question.

                                 : ilObjFileHandlingQuestionType
    {
        return $this->question;
    }

getRefId()

ilAssFileUploadUploadsExporter::getRefId

(

)

Returns

int

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

References $refId.

Referenced by getParticipantData().

                              : int
    {
        return $this->refId;
    }

Here is the caller graph for this function:

getTestId()

ilAssFileUploadUploadsExporter::getTestId

(

)

Returns

int

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

References $testId.

Referenced by collectUploadedFiles(), getFileUploadSolutionData(), and getParticipantData().

                               : int
    {
        return $this->testId;
    }

Here is the caller graph for this function:

getTestTitle()

ilAssFileUploadUploadsExporter::getTestTitle

(

)

Returns

string

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

References $testTitle.

Referenced by initFilenames().

                                  : string
    {
        return $this->testTitle;
    }

Here is the caller graph for this function:

getZipFileMimeType()

ilAssFileUploadUploadsExporter::getZipFileMimeType

(

)

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

                                        : string
    {
        return self::ZIP_FILE_MIME_TYPE;
    }

initFilenames()

ilAssFileUploadUploadsExporter::initFilenames ( )

private

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

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

Referenced by build().

                                    : 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())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeFileUploadCollection()

ilAssFileUploadUploadsExporter::removeFileUploadCollection ( )

private

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

References ilFileUtils\delDir().

Referenced by build().

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

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 148 of file class.ilAssFileUploadUploadsExporter.php.

References $question.

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

setRefId()

ilAssFileUploadUploadsExporter::setRefId

(

$refId

)

Parameters

int

$refId

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

References $refId.

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

setTestId()

ilAssFileUploadUploadsExporter::setTestId

(

$testId

)

Parameters

int

$testId

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

References $testId.

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

setTestTitle()

ilAssFileUploadUploadsExporter::setTestTitle

(

$testTitle

)

Parameters

string

$testTitle

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

References $testTitle.

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

Field Documentation

$db

ilAssFileUploadUploadsExporter::$db

protected

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

Referenced by __construct().

$finalZipFilePath

ilAssFileUploadUploadsExporter::$finalZipFilePath

private

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

Referenced by getFinalZipFilePath().

$lng

ilAssFileUploadUploadsExporter::$lng

protected

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

Referenced by __construct().

$mainFolderName

ilAssFileUploadUploadsExporter::$mainFolderName

private

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

$question

ilAssFileUploadUploadsExporter::$question

private

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

Referenced by getQuestion(), and setQuestion().

$refId

ilAssFileUploadUploadsExporter::$refId

protected

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

Referenced by getRefId(), and setRefId().

$tempDirPath

ilAssFileUploadUploadsExporter::$tempDirPath

private

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

$tempZipFilePath

ilAssFileUploadUploadsExporter::$tempZipFilePath

private

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

$testId

ilAssFileUploadUploadsExporter::$testId

private

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

Referenced by getTestId(), and setTestId().

$testTitle

ilAssFileUploadUploadsExporter::$testTitle

private

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

Referenced by getTestTitle(), and setTestTitle().

ZIP_FILE_EXTENSION

const ilAssFileUploadUploadsExporter::ZIP_FILE_EXTENSION = '.zip'

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

ZIP_FILE_MIME_TYPE

const ilAssFileUploadUploadsExporter::ZIP_FILE_MIME_TYPE = 'application/zip'

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

---

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

• Modules/TestQuestionPool/classes/class.ilAssFileUploadUploadsExporter.php