Download submissions and feedback for exercises. More...

Collaboration diagram for ilDownloadSubmissionsBackgroundTask:

Public Member Functions
	__construct (int $a_usr_id, int $a_exc_ref_id, int $a_exc_id, int $a_ass_id, int $a_participant_id, ?array $selected_participants=null)

	run ()

Protected Member Functions
	getParticipantBucketTitle ()

Protected Attributes
array	$selected_participants

int	$exc_ref_id

int	$exc_id

int	$ass_id

int	$participant_id

int	$user_id

TaskFactory	$task_factory = null

TaskManager	$task_manager = null

ilLanguage	$lng

ilLogger	$logger = null

Detailed Description

Download submissions and feedback for exercises.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilDownloadSubmissionsBackgroundTask::__construct	(	int	$a_usr_id,
		int	$a_exc_ref_id,
		int	$a_exc_id,
		int	$a_ass_id,
		int	$a_participant_id,
		?array	$selected_participants = `null`
	)

PhpUndefinedMethodInspection

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

References $DIC, $selected_participants, and ILIAS\Repository\logger().

       {
         global $DIC;
 
         $this->user_id = $a_usr_id;
         $this->exc_ref_id = $a_exc_ref_id;
         $this->exc_id = $a_exc_id;
         $this->ass_id = $a_ass_id;
         $this->participant_id = $a_participant_id;
         $this->selected_participants = $selected_participants;
 
         $this->task_factory = $DIC->backgroundTasks()->taskFactory();
         $this->task_manager = $DIC->backgroundTasks()->taskManager();
         $this->logger = $DIC->logger()->exc();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getParticipantBucketTitle()

ilDownloadSubmissionsBackgroundTask::getParticipantBucketTitle ( )

protected

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

References ilObjUser\_lookupName().

Referenced by run().

                                                   : string
     {
         $name = ilObjUser::_lookupName($this->participant_id);
         return ucfirst($name['lastname']) . ", " . ucfirst($name['firstname']);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilDownloadSubmissionsBackgroundTask::run ( )

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

References ilFileUtils\getASCIIFilename(), ilExSubmission\getDirectoryNameFromUserData(), getParticipantBucketTitle(), ILIAS\Repository\logger(), and ilExAssignment\lookupTitle().

                          : bool
     {
         $bucket = new BasicBucket();
         $bucket->setUserId($this->user_id);
 
         $this->logger->debug("* Create task 'collect_data_job' using the following values:");
         $this->logger->debug("job class = " . ilExerciseManagementCollectFilesJob::class);
         $this->logger->debug("exc_id = " . $this->exc_id . ", exc_ref_id = " . $this->exc_ref_id . ", ass_id = " . (int) $this->ass_id . ", participant_id = " . (int) $this->participant_id . ", user_id = " . $this->user_id);
 
         $sel_participants = $this->selected_participants
             ? implode(",", $this->selected_participants)
             : "";
         $collect_data_job = $this->task_factory->createTask(
             ilExerciseManagementCollectFilesJob::class,
             [
                 $this->exc_id,
                 $this->exc_ref_id,
                 (int) $this->ass_id,
                 (int) $this->participant_id,
                 $this->user_id,
                 $sel_participants
             ]
         );
 
         $this->logger->debug("* Create task 'zip job' using the following values:");
         $this->logger->debug("job class = " . ilSubmissionsZipJob::class);
         $this->logger->debug("sending as input the task called->collect_data_job");
 
         $zip_job = $this->task_factory->createTask(ilSubmissionsZipJob::class, [$collect_data_job]);
 
         if ($this->participant_id > 0) {
             $download_name = ilExSubmission::getDirectoryNameFromUserData($this->participant_id);
             $bucket->setTitle($this->getParticipantBucketTitle());
         } else {
             $download_name = ilFileUtils::getASCIIFilename(ilExAssignment::lookupTitle($this->ass_id));
             $bucket->setTitle($download_name);
         }
 
 
         $this->logger->debug("* Create task 'download_interaction' using the following values:");
         $this->logger->debug("job class = " . ilExDownloadSubmissionsZipInteraction::class);
         $this->logger->debug("download_name which is the same as bucket title = " . $download_name . " + the zip_job task");
         // see comments here -> https://github.com/leifos-gmbh/ILIAS/commit/df6fc44a4c85da33bd8dd5b391a396349e7fa68f
         $download_interaction = $this->task_factory->createTask(ilExDownloadSubmissionsZipInteraction::class, [$zip_job, $download_name]);
 
         //download name
         $bucket->setTask($download_interaction);
         $this->task_manager->run($bucket);
         return true;
     }