ilExerciseManagementCollectFilesJob Class Reference

Inheritance diagram for ilExerciseManagementCollectFilesJob:

Collaboration diagram for ilExerciseManagementCollectFilesJob:

Public Member Functions
	__construct ()
	Constructor. More...
	getInputTypes ()
	getOutputType ()
	isStateless ()
	run (array $input, Observer $observer)
	run the job More...
	copyFileToSubDirectory (string $a_directory, \ILIAS\Exercise\PeerReview\Criteria\CriteriaFile $file)
	Copy a file in the Feedback_files directory TODO use the new filesystem. More...
	getExpectedTimeOfTaskInSeconds ()
	collectSubmissionFiles ()
	Store the zip file which contains all submission files in the target directory. More...
	getExtraColumnsForSubmissionFiles (int $a_obj_id, int $a_ass_id)
	Get the number of max amount of files submitted by a single user in the assignment. More...
	addLink (int $a_row, int $a_col, Submission $sub)
	getAssignmentMembersIds ()
	get ONLY the members ids for this assignment More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns Value[] More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)
	getOutput ()
	getInput ()
	getType ()
	unfoldTask ()
	Unfold the task. More...
	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...
	getAbortOption ()
	Returns Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible. More...
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()
	run (array $input, Observer $observer)
	isStateless ()
	getInput ()
	getExpectedTimeOfTaskInSeconds ()

Data Fields
const	FBK_DIRECTORY = "Feedback_files"
const	LINK_COLOR = "0,0,255"
const	BG_COLOR = "255,255,255"
const	PARTICIPANT_LASTNAME_COLUMN = 0
const	PARTICIPANT_FIRSTNAME_COLUMN = 1
const	PARTICIPANT_LOGIN_COLUMN = 2
const	SUBMISSION_DATE_COLUMN = 3
const	FIRST_DEFAULT_SUBMIT_COLUMN = 4
const	FIRST_DEFAULT_REVIEW_COLUMN = 5
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'

Protected Member Functions
	addColumnTitles ()
	Set the Excel column titles. More...
	createUniqueTempDirectory ()
	createTargetDirectory ()
	Create the directory with the assignment title. More...
	createSubmissionsDirectory ()
	Create the directory with the assignment title. More...
	isExcelNeeded (int $a_ass_type, bool $a_has_fbk)
	getFeedbackDirectory (int $participant_id, int $feedback_giver)
	see also bug https://mantis.ilias.de/view.php?id=30999 More...
	collectAssignmentData (int $assignment_id)
	write assignment data to excel file More...
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes (array $values)
	extractType ($value)

Protected Attributes
ILIAS Exercise PeerReview DomainService	$peer_review
InternalDomainService	$domain
ILIAS Exercise Team TeamManager	$team
ilLogger	$logger
string	$target_directory = ""
string	$submissions_directory = ""
ilExAssignment	$assignment
int	$user_id = 0
int	$exercise_id = 0
int	$exercise_ref_id = 0
string	$temp_dir = null
ilLanguage	$lng
string	$sanitized_title = ""
ilExcel	$excel
array	$criteria_items = []
array	$title_columns = []
array	$ass_types_with_files = []
int	$participant_id = 0
array	$selected_participants = null
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array	$input = []
Value	$output

Detailed Description

Author

Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilExerciseManagementCollectFilesJob::__construct

(

)

Constructor.

@noinspection PhpUndefinedMethodInspection

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

    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('exc');
        //TODO will be deprecated when use the new assignment type interface
        $this->ass_types_with_files = array(
            ilExAssignment::TYPE_UPLOAD,
            ilExAssignment::TYPE_UPLOAD_TEAM,
            ilExAssignment::TYPE_BLOG,
            ilExAssignment::TYPE_PORTFOLIO
        );
        $this->logger = $DIC->logger()->exc();
        $this->domain = $DIC->exercise()->internal()->domain();
        $this->peer_review = $this->domain->peerReview();
        $this->team = $DIC->exercise()->internal()->domain()->team();
    }

References $DIC, ILIAS\Repository\lng(), ILIAS\Repository\logger(), ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, ilExAssignment\TYPE_UPLOAD, and ilExAssignment\TYPE_UPLOAD_TEAM.

Here is the call graph for this function:

Member Function Documentation

addColumnTitles()

ilExerciseManagementCollectFilesJob::addColumnTitles ( )

protected

Set the Excel column titles.

Exceptions

PhpOffice\PhpSpreadsheet\Exception

Definition at line 191 of file class.ilExerciseManagementCollectFilesJob.php.

                                        : void
    {
        $col = 0;
        foreach ($this->title_columns as $title) {
            $this->excel->setCell(1, $col, $title);
            $col++;
        }
    }

addLink()

ilExerciseManagementCollectFilesJob::addLink	(	int	$a_row,
		int	$a_col,
		Submission	$sub
	)

Definition at line 407 of file class.ilExerciseManagementCollectFilesJob.php.

     : void {
        $user_id = $sub->getUserId();
        $targetdir = ilExSubmission::getDirectoryNameFromUserData($user_id);
 
        $filepath = './' . $this->lng->txt("exc_ass_submission_zip") . DIRECTORY_SEPARATOR . $targetdir . DIRECTORY_SEPARATOR;
        switch ($this->assignment->getType()) {
            case ilExAssignment::TYPE_UPLOAD:
                $filepath .= $sub->getTitle();
                break;
 
            case ilExAssignment::TYPE_BLOG:
                $wsp_tree = new ilWorkspaceTree($user_id);
                // #12939
                if (!$wsp_tree->getRootId()) {
                    $wsp_tree->createTreeForUser($user_id);
                }
                $node = $wsp_tree->getNodeData((int) $sub->getTitle());
                $filepath .= "blog_" . $node['obj_id'] . DIRECTORY_SEPARATOR . "index.html";
                break;
 
            case ilExAssignment::TYPE_PORTFOLIO:
                $filepath .= "prt_" . $sub->getTitle() . DIRECTORY_SEPARATOR . "index.html";
                break;
 
            default:
                $filepath = "";
        }
        $this->excel->addLink($a_row, $a_col, $filepath);
    }

collectAssignmentData()

ilExerciseManagementCollectFilesJob::collectAssignmentData ( int  $assignment_id )

protected

write assignment data to excel file

Todo:

Refactoring needed, long method...

Parameters

int

$assignment_id

Exceptions

PhpOffice\PhpSpreadsheet\Exception

Exceptions

ilDatabaseException
ilExerciseException
ilObjectNotFoundException

Definition at line 450 of file class.ilExerciseManagementCollectFilesJob.php.

                                                                : void
    {
        $ass_has_feedback = false;
        $ass_has_criteria = false;
 
        //assignment object
        $this->assignment = new ilExAssignment($assignment_id);
        $assignment_type = $this->assignment->getType();
 
        //Sanitized title for excel file and target directory.
        $this->sanitized_title = ilFileUtils::getASCIIFilename($this->assignment->getTitle());
 
        // directories
        if (!isset($this->temp_dir)) {
            $this->createUniqueTempDirectory();
        }
        $this->createTargetDirectory();
 
        //Collect submission files if needed by assignment type.
        if (in_array($assignment_type, $this->ass_types_with_files)) {
            $this->createSubmissionsDirectory();
            $this->collectSubmissionFiles();
        }
 
        $first_excel_column_for_review = 0;
        $col = 0;
        $peer_review = null;
        if ($this->assignment->getPeerReview()) {
            $ass_has_feedback = true;
            //obj to get the reviews in the foreach below.
            $peer_review = new ilExPeerReview($this->assignment);
            //default start column for revisions.
            $first_excel_column_for_review = self::FIRST_DEFAULT_REVIEW_COLUMN;
        }
 
        if ($this->isExcelNeeded($assignment_type, $ass_has_feedback)) {
            // PhpSpreadsheet object
            $this->excel = new ilExcel();
 
            //Excel sheet title
            $this->excel->addSheet($this->sanitized_title);
 
            //add common excel Columns
            #25585
            $this->title_columns = array(
                $this->lng->txt('lastname'),
                $this->lng->txt('firstname'),
                $this->lng->txt('login'),
                $this->lng->txt('exc_last_submission')
            );
            switch ($assignment_type) {
                case ilExAssignment::TYPE_TEXT:
                    $this->title_columns[] = $this->lng->txt("exc_submission_text");
                    break;
                case ilExAssignment::TYPE_UPLOAD:
                case ilExAssignment::TYPE_UPLOAD_TEAM:
                    if ($assignment_type === ilExAssignment::TYPE_UPLOAD_TEAM) {
                        $first_excel_column_for_review++;
                        $this->title_columns[] = $this->lng->txt("exc_team");
                    }
                    $num_columns_submission = $this->getExtraColumnsForSubmissionFiles($this->exercise_id, $assignment_id);
                    if ($num_columns_submission > 1) {
                        for ($i = 1; $i <= $num_columns_submission; $i++) {
                            $this->title_columns[] = $this->lng->txt("exc_submission_file") . " " . $i;
                        }
                    } else {
                        $this->title_columns[] = $this->lng->txt("exc_submission_file");
                    }
 
                    $first_excel_column_for_review += $num_columns_submission - 1;
                    break;
                default:
                    $this->title_columns[] = $this->lng->txt("exc_submission");
                    break;
            }
            if ($ass_has_feedback) {
                $this->title_columns[] = $this->lng->txt("exc_peer_review_giver");
                $this->title_columns[] = $this->lng->txt('exc_last_submission');
            }
 
            //criteria
            //Notice:getPeerReviewCriteriaCatalogueItems can return just an empty instance without data.
            if ($this->criteria_items = $this->assignment->getPeerReviewCriteriaCatalogueItems()) {
                $ass_has_criteria = true;
            }
 
            if ($this->participant_id > 0) {
                $participants = array($this->participant_id);
            } else {
                $participants = $this->getAssignmentMembersIds();
            }
 
            $filter = new ilExerciseMembersFilter($this->exercise_ref_id, $participants, $this->user_id);
            $participants = $filter->filterParticipantsByAccess();
 
            $row = 2;
            // Fill the excel
            foreach ($participants as $participant_id) {
                if (!is_null($this->selected_participants) && !in_array($participant_id, $this->selected_participants)) {
                    continue;
                }
 
                $submissions = $this->domain->submission($this->assignment->getId())
                    ->getSubmissionsOfUser($participant_id);
 
                if ($submissions->current()) {
                    $participant_name = ilObjUser::_lookupName($participant_id);
                    $this->excel->setCell($row, self::PARTICIPANT_LASTNAME_COLUMN, $participant_name['lastname']);
                    $this->excel->setCell($row, self::PARTICIPANT_FIRSTNAME_COLUMN, $participant_name['firstname']);
                    $this->excel->setCell($row, self::PARTICIPANT_LOGIN_COLUMN, $participant_name['login']);
 
                    //Get the submission Text
                    if (!in_array($assignment_type, $this->ass_types_with_files)) {
                        foreach ($submissions as $sub) {
                            $this->excel->setCell($row, self::SUBMISSION_DATE_COLUMN, $sub->getTimestamp());
                            $this->excel->setCell($row, self::FIRST_DEFAULT_SUBMIT_COLUMN, $sub->getText());
                        }
                    } else {
                        $col = self::FIRST_DEFAULT_SUBMIT_COLUMN;
                        if ($assignment_type === ilExAssignment::TYPE_UPLOAD_TEAM) {
                            $team_id = $this->team->getTeamForMember($this->assignment->getId(), $participant_id);
                            $this->excel->setCell($row, $col, (string) $team_id);
                            $col++;
                        }
                        foreach ($submissions as $sub) {
                            $this->excel->setCell($row, self::SUBMISSION_DATE_COLUMN, $sub->getTimestamp());
 
                            if ($assignment_type == ilExAssignment::TYPE_PORTFOLIO || $assignment_type == ilExAssignment::TYPE_BLOG) {
                                $this->excel->setCell($row, $col, $this->lng->txt("open"));
                            } else {
                                $this->excel->setCell($row, $col, $sub->getTitle());
                            }
                            $this->excel->setColors($this->excel->getCoordByColumnAndRow($col, $row), self::BG_COLOR, self::LINK_COLOR);
                            if ($assignment_type != ilExAssignment::TYPE_UPLOAD_TEAM) {
                                $this->addLink($row, $col, $sub);
                            }
                            $col++; //does not affect blogs and portfolios.
                        }
                    }
 
                    if ($ass_has_feedback) {
                        if ($col < $first_excel_column_for_review) {
                            $col = $first_excel_column_for_review;
                        }
                        $reviews = [];
                        if ($peer_review !== null) {
                            $reviews = $peer_review->getPeerReviewsByPeerId($participant_id);
                        }
 
                        //extra lines
                        $current_review_row = 0;
                        foreach ($reviews as $review) {
                            //not all reviews are done, we check it via date of review.
                            if ($review['tstamp']) {
                                $current_review_row++;
                                if ($current_review_row > 1) {
                                    for ($i = 0; $i < $first_excel_column_for_review; $i++) {
                                        $cell_to_copy = $this->excel->getCell($row, $i);
                                        $this->excel->setCell($row + 1, $i, $cell_to_copy);
                                        if ($i >= self::FIRST_DEFAULT_SUBMIT_COLUMN) {
                                            $this->excel->setColors($this->excel->getCoordByColumnAndRow($i, $row + 1), self::BG_COLOR, self::LINK_COLOR);
                                        }
                                    }
                                    ++$row;
                                }
 
                                $feedback_giver = $review['giver_id']; // user who made the review.
 
                                $feedback_giver_name = ilObjUser::_lookupName($feedback_giver);
 
                                $this->excel->setCell(
                                    $row,
                                    $col,
                                    $feedback_giver_name['lastname'] . ", " . $feedback_giver_name['firstname'] . " [" . $feedback_giver_name['login'] . "]"
                                );
 
                                $this->excel->setCell($row, $col + 1, $review['tstamp']);
 
                                if ($ass_has_criteria) {
                                    $this->addCriteriaToExcel($feedback_giver, $participant_id, $row, $col + 1);
                                }
                            }
                        }
                    }
 
                    $row++;
                }
            }
 
            $this->addColumnTitles();
            $this->excel->writeToFile($this->target_directory . "/" . $this->sanitized_title);
        }
    }

References ilObjUser\_lookupName(), ilFileUtils\getASCIIFilename(), ILIAS\Repository\lng(), ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, ilExAssignment\TYPE_TEXT, ilExAssignment\TYPE_UPLOAD, and ilExAssignment\TYPE_UPLOAD_TEAM.

Here is the call graph for this function:

collectSubmissionFiles()

ilExerciseManagementCollectFilesJob::collectSubmissionFiles

(

)

Store the zip file which contains all submission files in the target directory.

TODO -> put the reference of the original code. Possible TODO -> extract this to another BT job.

Exceptions

ilDatabaseException
ilExerciseException
ilObjectNotFoundException

Definition at line 242 of file class.ilExerciseManagementCollectFilesJob.php.

                                            : void
    {
        $members = array();
 
        $exercise = new ilObjExercise($this->exercise_id, false);
 
        if ($this->participant_id > 0) {
            $exc_members_id = array($this->participant_id);
        } else {
            $exc_members_id = $exercise->members_obj->getMembers();
        }
 
        $filter = new ilExerciseMembersFilter($this->exercise_ref_id, $exc_members_id, $this->user_id);
        $exc_members_id = $filter->filterParticipantsByAccess();
 
        $user_ids = [];
        foreach ($exc_members_id as $member_id) {
            if (!is_null($this->selected_participants) && !in_array($member_id, $this->selected_participants)) {
                continue;
            }
            $user_ids[] = $member_id;
        }
 
        $this->domain->submission($this->assignment->getId())
            ->copySubmissionsToDir(
                $user_ids,
                $this->submissions_directory
            );
    }

References $exercise.

copyFileToSubDirectory()

ilExerciseManagementCollectFilesJob::copyFileToSubDirectory	(	string	$a_directory,
		\ILIAS\Exercise\PeerReview\Criteria\CriteriaFile	$file
	)

Copy a file in the Feedback_files directory TODO use the new filesystem.

Definition at line 163 of file class.ilExerciseManagementCollectFilesJob.php.

                                                                                                                       : void
    {
        $crit_file_manager = $this->peer_review->criteriaFile($this->assignment->getId());
        $dir = $this->target_directory . "/" . $a_directory;
 
        if (!is_dir($dir)) {
            ilFileUtils::makeDirParents($dir);
        }
 
        $f = fopen($dir . "/" . basename($file->getTitle()), 'wb');
        fwrite($f, $crit_file_manager->getStream($file->getRid())->getContents());
        fclose($f);
 
        /*global $DIC;
        $fs = $DIC->filesystem();
 
        $fs->storage()->copy($a_file, $this->temp_dir."/".basename($a_file));*/
    }

References Vendor\Package\$f, and ilFileUtils\makeDirParents().

Here is the call graph for this function:

createSubmissionsDirectory()

ilExerciseManagementCollectFilesJob::createSubmissionsDirectory ( )

protected

Create the directory with the assignment title.

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

                                                   : void
    {
        $this->logger->dump("lang key => " . $this->lng->getLangKey());
        $this->submissions_directory = $this->target_directory . DIRECTORY_SEPARATOR . $this->lng->txt("exc_ass_submission_zip");
        ilFileUtils::createDirectory($this->submissions_directory);
    }

References ilFileUtils\createDirectory(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

Here is the call graph for this function:

createTargetDirectory()

ilExerciseManagementCollectFilesJob::createTargetDirectory ( )

protected

Create the directory with the assignment title.

Definition at line 213 of file class.ilExerciseManagementCollectFilesJob.php.

                                              : void
    {
        $path = $this->temp_dir . DIRECTORY_SEPARATOR;
        if ($this->participant_id > 0) {
            $user_dir = ilExSubmission::getDirectoryNameFromUserData($this->participant_id);
            $path .= $user_dir . DIRECTORY_SEPARATOR;
        }
        $this->target_directory = $path . $this->sanitized_title;
        ilFileUtils::makeDirParents($this->target_directory);
    }

References $path, ilExSubmission\getDirectoryNameFromUserData(), and ilFileUtils\makeDirParents().

Here is the call graph for this function:

createUniqueTempDirectory()

ilExerciseManagementCollectFilesJob::createUniqueTempDirectory ( )

protected

Todo:

refactor to new file system access Create unique temp directory

Definition at line 204 of file class.ilExerciseManagementCollectFilesJob.php.

                                                  : void
    {
        $this->temp_dir = ilFileUtils::ilTempnam();
        ilFileUtils::makeDirParents($this->temp_dir);
    }

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

Here is the call graph for this function:

getAssignmentMembersIds()

ilExerciseManagementCollectFilesJob::getAssignmentMembersIds

(

)

get ONLY the members ids for this assignment

Returns

int[]

Definition at line 648 of file class.ilExerciseManagementCollectFilesJob.php.

                                             : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $members = array();
 
        $set = $ilDB->query("SELECT usr_id" .
            " FROM exc_mem_ass_status" .
            " WHERE ass_id = " . $ilDB->quote($this->assignment->getId(), "integer"));
 
        while ($rec = $ilDB->fetchAssoc($set)) {
            if (!\ilObjUser::userExists([(int) $rec['usr_id']])) {
                continue;
            }
            $members[] = $rec['usr_id'];
        }
 
        return $members;
    }

References $DIC, $ilDB, and ilObjUser\userExists().

Here is the call graph for this function:

getExpectedTimeOfTaskInSeconds()

ilExerciseManagementCollectFilesJob::getExpectedTimeOfTaskInSeconds

(

)

Returns

int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implements ILIAS\BackgroundTasks\Task\Job.

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

                                                    : int
    {
        return 30;
    }

getExtraColumnsForSubmissionFiles()

ilExerciseManagementCollectFilesJob::getExtraColumnsForSubmissionFiles	(	int	$a_obj_id,
		int	$a_ass_id
	)

Get the number of max amount of files submitted by a single user in the assignment.

Used to add columns to the excel.

Definition at line 398 of file class.ilExerciseManagementCollectFilesJob.php.

                                                                                   : int
    {
        $subm = $this->domain->submission($a_ass_id);
        return $subm->getMaxAmountOfSubmittedFiles(
            $this->participant_id
        );
    }

getFeedbackDirectory()

ilExerciseManagementCollectFilesJob::getFeedbackDirectory ( int  $participant_id, int  $feedback_giver  )

protected

see also bug https://mantis.ilias.de/view.php?id=30999

Definition at line 386 of file class.ilExerciseManagementCollectFilesJob.php.

                                                                                     : string
    {
        $dir = self::FBK_DIRECTORY . DIRECTORY_SEPARATOR .
            "to_" . ilExSubmission::getDirectoryNameFromUserData($participant_id) . DIRECTORY_SEPARATOR .
            "from_" . ilExSubmission::getDirectoryNameFromUserData($feedback_giver);
        return $dir;
    }

References ilExSubmission\getDirectoryNameFromUserData().

Here is the call graph for this function:

getInputTypes()

ilExerciseManagementCollectFilesJob::getInputTypes

(

)

Returns

\ILIAS\BackgroundTasks\Types\SingleType[]

Implements ILIAS\BackgroundTasks\Task.

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

                                   : array
    {
        return
            [
                new SingleType(IntegerValue::class),
                new SingleType(IntegerValue::class),
                new SingleType(IntegerValue::class),
                new SingleType(IntegerValue::class),
                new SingleType(IntegerValue::class),
                new SingleType(StringValue::class),
            ];
    }

getOutputType()

ilExerciseManagementCollectFilesJob::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

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

                                   : Type
    {
        return new SingleType(StringValue::class);
    }

isExcelNeeded()

ilExerciseManagementCollectFilesJob::isExcelNeeded ( int  $a_ass_type, bool  $a_has_fbk  )

protected

Definition at line 272 of file class.ilExerciseManagementCollectFilesJob.php.

                                                                      : bool
    {
        if ($a_ass_type == ilExAssignment::TYPE_TEXT || $a_ass_type == ilExAssignment::TYPE_UPLOAD
            || $a_ass_type == ilExAssignment::TYPE_UPLOAD_TEAM) {
            return true;
        } elseif ($a_has_fbk && $a_ass_type != ilExAssignment::TYPE_UPLOAD_TEAM) {
            return true;
        }
        return false;
    }

References ilExAssignment\TYPE_TEXT, ilExAssignment\TYPE_UPLOAD, and ilExAssignment\TYPE_UPLOAD_TEAM.

isStateless()

ilExerciseManagementCollectFilesJob::isStateless

(

)

Returns

bool returns true iff the job's output ONLY depends on the input. Stateless task results may be cached!

Implements ILIAS\BackgroundTasks\Task\Job.

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

                                 : bool
    {
        return true;
    }

run()

ilExerciseManagementCollectFilesJob::run	(	array	$input,
		Observer	$observer
	)

run the job

Exceptions

ILIAS\BackgroundTasks\Exceptions\InvalidArgumentException

Exceptions

PhpOffice\PhpSpreadsheet\Exception

Exceptions

ilDatabaseException
ilExerciseException
ilObjectNotFoundException

Implements ILIAS\BackgroundTasks\Task\Job.

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

     : Value {
        $this->exercise_id = $input[0]->getValue();
        $this->exercise_ref_id = $input[1]->getValue();
        $assignment_id = $input[2]->getValue();
        $participant_id = $input[3]->getValue();
        $this->user_id = $input[4]->getValue();
        $selected_participants = $input[5]->getValue();
        $this->logger->debug("Collect files. assignment id: " . $assignment_id . ", selected participants: " . $selected_participants);
        if (trim($selected_participants) === "") {
            $this->selected_participants = null;
        } else {
            $this->selected_participants = explode(",", $selected_participants);
        }
        $final_directory = "";
 
        //if we have assignment
        if ($assignment_id > 0) {
            $this->collectAssignmentData($assignment_id);
            $final_directory = $this->target_directory;
        }
 
        if ($participant_id > 0) {
            $this->participant_id = $participant_id;
            $assignments = ilExAssignment::getInstancesByExercise($this->exercise_id);
            foreach ($assignments as $assignment) {
                $this->collectAssignmentData($assignment->getId());
            }
            $final_directory = $this->temp_dir . DIRECTORY_SEPARATOR . ilExSubmission::getDirectoryNameFromUserData($participant_id);
        }
 
        $out = new StringValue();
        $out->setValue($final_directory);
        return $out;
    }

Field Documentation

$ass_types_with_files

array ilExerciseManagementCollectFilesJob::$ass_types_with_files = []

protected

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

$assignment

ilExAssignment ilExerciseManagementCollectFilesJob::$assignment

protected

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

$criteria_items

array ilExerciseManagementCollectFilesJob::$criteria_items = []

protected

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

$domain

InternalDomainService ilExerciseManagementCollectFilesJob::$domain

protected

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

$excel

ilExcel ilExerciseManagementCollectFilesJob::$excel

protected

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

$exercise_id

int ilExerciseManagementCollectFilesJob::$exercise_id = 0

protected

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

$exercise_ref_id

int ilExerciseManagementCollectFilesJob::$exercise_ref_id = 0

protected

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

$lng

ilLanguage ilExerciseManagementCollectFilesJob::$lng

protected

Definition at line 56 of file class.ilExerciseManagementCollectFilesJob.php.

$logger

ilLogger ilExerciseManagementCollectFilesJob::$logger

protected

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

$participant_id

int ilExerciseManagementCollectFilesJob::$participant_id = 0

protected

Definition at line 62 of file class.ilExerciseManagementCollectFilesJob.php.

$peer_review

ILIAS Exercise PeerReview DomainService ilExerciseManagementCollectFilesJob::$peer_review

protected

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

$sanitized_title

string ilExerciseManagementCollectFilesJob::$sanitized_title = ""

protected

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

$selected_participants

array ilExerciseManagementCollectFilesJob::$selected_participants = null

protected

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

$submissions_directory

string ilExerciseManagementCollectFilesJob::$submissions_directory = ""

protected

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

$target_directory

string ilExerciseManagementCollectFilesJob::$target_directory = ""

protected

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

$team

ILIAS Exercise Team TeamManager ilExerciseManagementCollectFilesJob::$team

protected

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

$temp_dir

string ilExerciseManagementCollectFilesJob::$temp_dir = null

protected

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

$title_columns

array ilExerciseManagementCollectFilesJob::$title_columns = []

protected

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

$user_id

int ilExerciseManagementCollectFilesJob::$user_id = 0

protected

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

BG_COLOR

const ilExerciseManagementCollectFilesJob::BG_COLOR = "255,255,255"

Definition at line 36 of file class.ilExerciseManagementCollectFilesJob.php.

FBK_DIRECTORY

const ilExerciseManagementCollectFilesJob::FBK_DIRECTORY = "Feedback_files"

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

FIRST_DEFAULT_REVIEW_COLUMN

const ilExerciseManagementCollectFilesJob::FIRST_DEFAULT_REVIEW_COLUMN = 5

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

FIRST_DEFAULT_SUBMIT_COLUMN

const ilExerciseManagementCollectFilesJob::FIRST_DEFAULT_SUBMIT_COLUMN = 4

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

LINK_COLOR

const ilExerciseManagementCollectFilesJob::LINK_COLOR = "0,0,255"

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

PARTICIPANT_FIRSTNAME_COLUMN

const ilExerciseManagementCollectFilesJob::PARTICIPANT_FIRSTNAME_COLUMN = 1

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

PARTICIPANT_LASTNAME_COLUMN

const ilExerciseManagementCollectFilesJob::PARTICIPANT_LASTNAME_COLUMN = 0

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

PARTICIPANT_LOGIN_COLUMN

const ilExerciseManagementCollectFilesJob::PARTICIPANT_LOGIN_COLUMN = 2

Definition at line 40 of file class.ilExerciseManagementCollectFilesJob.php.

SUBMISSION_DATE_COLUMN

const ilExerciseManagementCollectFilesJob::SUBMISSION_DATE_COLUMN = 3

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

---

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

• components/ILIAS/Exercise/classes/BackgroundTasks/class.ilExerciseManagementCollectFilesJob.php