Collaboration diagram for ILIAS\Exercise\Submission\SubmissionManager:

Public Member Functions
	__construct (InternalRepoService $repo, protected InternalDomainService $domain, protected \ilExcSubmissionStakeholder $stakeholder, protected int $ass_id)

	countSubmissionsOfUser (int $user_id)

	getSubmissionsOfUser (int $user_id, ?array $submit_ids=null, bool $only_valid=false, ?string $min_timestamp=null, bool $print_versions=false)
	Note: this includes submissions of other team members, if user is in a team. More...

	getSubmissionsOfOwners (array $user_ids)
	This is only suitable for types like text or single upload, where no teams are used. More...

	recalculateLateSubmissions ()

	getAllAssignmentFiles ()

	getMaxAmountOfSubmittedFiles (int $user_id=0)

	getUsersWithSubmission ()
	Get all user ids, that have submitted something. More...

	addLocalFile (int $user_id, string $file, string $filename="")

	addUpload (int $user_id, UploadResult $result, string $filename="")

	addZipUploads (int $user_id, UploadResult $result)

	deliverFile (int $user_id, string $rid, string $filetitle="")

	copyRidToWebDir (string $rid, string $internal_file_path)

	deleteSubmissions (int $user_id, array $ids)
	Delete submissions. More...

	deleteAllSubmissionsOfUser (int $user_id)

	copySubmissionsToDir (array $user_ids, string $directory)
	Should be replaced by writing into a zip directly in the future. More...

Protected Member Functions
	remainingFilesAllowed (int $user_id)

	getAllSubmissionIdsOfUser (int $user_id)
	All, include print, include all from team. More...

	getDirectoryNameFromUserData (int $user_id)
	there is still a version in ilExSubmission that needs to be replaced More...

Protected Attributes
ilExAssignmentTypeInterface	$type

ILIAS Exercise Team TeamManager	$team

ilLogger	$log

SubmissionRepositoryInterface	$repo

ilExAssignment	$assignment

Detailed Description

Definition at line 28 of file SubmissionManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Exercise\Submission\SubmissionManager::__construct	(	InternalRepoService	$repo,
		protected InternalDomainService	$domain,
		protected \ilExcSubmissionStakeholder	$stakeholder,
		protected int	$ass_id
	)

Definition at line 36 of file SubmissionManager.php.

      {
        $this->assignment = $domain->assignment()->getAssignment($ass_id);
        $this->type = $this->assignment->getAssignmentType();
        $this->repo = $repo->submission();
        $this->log = $this->domain->logger()->exc();
        $this->team = $domain->team();
    }

References ILIAS\Exercise\Submission\Submission\$ass_id, ILIAS\Exercise\Submission\SubmissionManager\$repo, ILIAS\Exercise\InternalDomainService\assignment(), and ILIAS\Exercise\InternalDomainService\team().

Here is the call graph for this function:

Member Function Documentation

◆ addLocalFile()

ILIAS\Exercise\Submission\SubmissionManager::addLocalFile	(	int	$user_id,
		string	$file,
		string	$filename = `""`
	)

Definition at line 205 of file SubmissionManager.php.

     : bool {
 
        if ($filename === "") {
            $filename = basename($file);
        }
        $submission = new \ilExSubmission(
            $this->assignment,
            $user_id
        );
 
        if (!$submission->canAddFile()) {
            return false;
        }
 
        if ($this->type->isSubmissionAssignedToTeam()) {
            $team_id = $submission->getTeam()->getId();
            $user_id = 0;
            if ($team_id === 0) {
                return false;
            }
        } else {
            $team_id = 0;
        }
        $success = $this->repo->addLocalFile(
            $this->assignment->getExerciseId(),
            $this->ass_id,
            $user_id,
            $team_id,
            $file,
            $filename,
            $submission->isLate(),
            $this->stakeholder
        );
 
        if ($success && $team_id > 0) {
            $this->domain->team()->writeLog(
                $team_id,
                \ilExAssignmentTeam::TEAM_LOG_ADD_FILE,
                $filename
            );
        }
 
        return $success;
    }

References $filename.

◆ addUpload()

ILIAS\Exercise\Submission\SubmissionManager::addUpload	(	int	$user_id,
		UploadResult	$result,
		string	$filename = `""`
	)

Definition at line 254 of file SubmissionManager.php.

     : bool {
 
        if ($filename === "") {
            $filename = $result->getName();
        }
        $submission = new \ilExSubmission(
            $this->assignment,
            $user_id
        );
 
        if (!$submission->canAddFile()) {
            return false;
        }
 
        if ($this->type->isSubmissionAssignedToTeam()) {
            $team_id = $submission->getTeam()->getId();
            $user_id = 0;
            if ($team_id === 0) {
                return false;
            }
        } else {
            $team_id = 0;
        }
        $success = $this->repo->addUpload(
            $this->assignment->getExerciseId(),
            $this->ass_id,
            $user_id,
            $team_id,
            $result,
            $filename,
            $submission->isLate(),
            $this->stakeholder
        );
 
        if ($success && $team_id > 0) {
            $this->domain->team()->writeLog(
                $team_id,
                \ilExAssignmentTeam::TEAM_LOG_ADD_FILE,
                $filename
            );
        }
 
        return $success;
    }

References $filename, and ILIAS\FileUpload\DTO\UploadResult\getName().

Here is the call graph for this function:

◆ addZipUploads()

ILIAS\Exercise\Submission\SubmissionManager::addZipUploads	(	int	$user_id,
		UploadResult	$result
	)

Definition at line 318 of file SubmissionManager.php.

     : bool {
        $submission = new \ilExSubmission(
            $this->assignment,
            $user_id
        );
        if (!$submission->canAddFile()) {
            return false;
        }
        if ($this->type->isSubmissionAssignedToTeam()) {
            $team_id = $submission->getTeam()->getId();
            $user_id = 0;
            if ($team_id === 0) {
                return false;
            }
        } else {
            $team_id = 0;
        }
        $filenames = $this->repo->addZipUpload(
            $this->assignment->getExerciseId(),
            $this->ass_id,
            $user_id,
            $team_id,
            $result,
            $submission->isLate(),
            $this->stakeholder,
            $this->remainingFilesAllowed($user_id)
        );
        $this->log->debug("99");
        if ($team_id > 0) {
            foreach ($filenames as $filename) {
                $this->domain->team()->writeLog(
                    $team_id,
                    \ilExAssignmentTeam::TEAM_LOG_ADD_FILE,
                    $filename
                );
            }
        }
 
        return count($filenames) > 0;
    }

◆ copyRidToWebDir()

ILIAS\Exercise\Submission\SubmissionManager::copyRidToWebDir	(	string	$rid,
		string	$internal_file_path
	)

Definition at line 375 of file SubmissionManager.php.

     : ?string {
        global $DIC;
 
        $web_filesystem = $DIC->filesystem()->web();
 
        $internal_dirs = dirname($internal_file_path);
        $zip_file = basename($internal_file_path);
 
        if ($rid !== "") {
            //$this->log->debug("internal file path: " . $internal_file_path);
            if ($web_filesystem->hasDir($internal_dirs)) {
                $web_filesystem->deleteDir($internal_dirs);
            }
            $web_filesystem->createDir($internal_dirs);
            if ($web_filesystem->has($internal_file_path)) {
                $web_filesystem->delete($internal_file_path);
            }
            if (!$web_filesystem->has($internal_file_path)) {
                //$this->log->debug("writing: " . $internal_file_path);
                $stream = $this->repo->getStream(
                    $this->ass_id,
                    $rid
                );
                if (!is_null($stream)) {
                    $web_filesystem->writeStream($internal_file_path, $stream);
 
                    return ILIAS_ABSOLUTE_PATH .
                        DIRECTORY_SEPARATOR .
                        "public" .
                        DIRECTORY_SEPARATOR .
                        ILIAS_WEB_DIR .
                        DIRECTORY_SEPARATOR .
                        CLIENT_ID .
                        DIRECTORY_SEPARATOR .
                        $internal_dirs .
                        DIRECTORY_SEPARATOR .
                        $zip_file;
                }
            }
        }
 
        return null;
    }

◆ copySubmissionsToDir()

ILIAS\Exercise\Submission\SubmissionManager::copySubmissionsToDir	(	array	$user_ids,
		string	$directory
	)

Should be replaced by writing into a zip directly in the future.

Definition at line 478 of file SubmissionManager.php.

      {
        $members = [];
        foreach ($user_ids as $member_id) {
            $submission = new \ilExSubmission($this->assignment, $member_id);
            $submission->updateTutorDownloadTime();
 
            // get member object (ilObjUser)
            if ($this->domain->profile()->exists($member_id)) {
                // adding file metadata
                foreach ($this->getSubmissionsOfUser($member_id) as $sub) {
                    $members[$sub->getUserId()]["files"][$sub->getId()] = $sub;
                }
 
                $name = \ilObjUser::_lookupName($member_id);
                $members[$member_id]["name"] = $name["firstname"] . " " . $name["lastname"];
            }
        }
        $this->copySubmissionFilesToDir($members, $directory);
    }

References ilObjUser\_lookupName().

Here is the call graph for this function:

◆ countSubmissionsOfUser()

ILIAS\Exercise\Submission\SubmissionManager::countSubmissionsOfUser ( int $user_id )

Definition at line 49 of file SubmissionManager.php.

                                                        : int
    {
        return count(iterator_to_array(
            $this->getSubmissionsOfUser($user_id)
        ));
    }

References ILIAS\Exercise\Submission\SubmissionManager\getSubmissionsOfUser().

Here is the call graph for this function:

◆ deleteAllSubmissionsOfUser()

ILIAS\Exercise\Submission\SubmissionManager::deleteAllSubmissionsOfUser ( int $user_id )

Definition at line 467 of file SubmissionManager.php.

                                                            : void
    {
        $this->deleteSubmissions(
            $user_id,
            $this->getAllSubmissionIdsOfUser($user_id)
        );
    }

References $user_id.

◆ deleteSubmissions()

ILIAS\Exercise\Submission\SubmissionManager::deleteSubmissions	(	int	$user_id,
		array	$ids
	)

Delete submissions.

Definition at line 425 of file SubmissionManager.php.

                                                               : void
    {
        if (count($ids) == 0) {
            return;
        }
        $all = $this->getAllSubmissionIdsOfUser($user_id);
        foreach ($ids as $id) {
            // this ensures, the ids belong to user submissions at all
            if (!in_array($id, $all)) {
                continue;
            }
            $s = $this->repo->getById($id);
            $this->repo->delete(
                $id,
                $this->stakeholder
            );
            $team_id = $this->team->getTeamForMember($this->ass_id, $user_id);
            if ($team_id && $team_id > 0) {
                $this->team->writeLog(
                    $team_id,
                    \ilExAssignmentTeam::TEAM_LOG_REMOVE_FILE,
                    $s->getTitle()
                );
            }
        }
    }

References $id, $user_id, and ilExAssignmentTeam\TEAM_LOG_REMOVE_FILE.

◆ deliverFile()

ILIAS\Exercise\Submission\SubmissionManager::deliverFile	(	int	$user_id,
		string	$rid,
		string	$filetitle = `""`
	)

Definition at line 362 of file SubmissionManager.php.

     : void {
        $this->repo->deliverFile(
            $this->ass_id,
            $user_id,
            $rid,
            $filetitle
        );
    }

◆ getAllAssignmentFiles()

ILIAS\Exercise\Submission\SubmissionManager::getAllAssignmentFiles ( )

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 170 of file SubmissionManager.php.

                                           : array
    {
        $assignment = $this->assignment;
 
        $delivered = [];
        foreach ($this->repo->getAllEntriesOfAssignment($assignment->getId()) as $row) {
            $row["timestamp"] = $row["ts"];
            $delivered[] = $row;
        }
 
        return $delivered;
    }

◆ getAllSubmissionIdsOfUser()

ILIAS\Exercise\Submission\SubmissionManager::getAllSubmissionIdsOfUser ( int $user_id )

protected

All, include print, include all from team.

Definition at line 455 of file SubmissionManager.php.

                                                              : array
    {
        $subs = [];
        foreach ($this->getSubmissionsOfUser($user_id) as $s) {
            $subs[] = $s->getId();
        }
        foreach ($this->getSubmissionsOfUser($user_id, null, false, null, true) as $s) {
            $subs[] = $s->getId();
        }
        return $subs;
    }

References $user_id.

◆ getDirectoryNameFromUserData()

ILIAS\Exercise\Submission\SubmissionManager::getDirectoryNameFromUserData ( int $user_id )

protected

there is still a version in ilExSubmission that needs to be replaced

Definition at line 634 of file SubmissionManager.php.

                                                                 : string
    {
        $userName = \ilObjUser::_lookupName($user_id);
        return \ilFileUtils::getASCIIFilename(
            trim($userName["lastname"]) . "_" .
            trim($userName["firstname"]) . "_" .
            trim($userName["login"]) . "_" .
            $userName["user_id"]
        );
    }

References $user_id, and ilObjUser\_lookupName().

Here is the call graph for this function:

◆ getMaxAmountOfSubmittedFiles()

ILIAS\Exercise\Submission\SubmissionManager::getMaxAmountOfSubmittedFiles ( int $user_id = 0 )

Definition at line 183 of file SubmissionManager.php.

     : int {
        $ass = $this->assignment;
        return $this->repo->getMaxAmountOfSubmittedFiles(
            $ass->getExerciseId(),
            $ass->getId(),
            $user_id
        );
    }

◆ getSubmissionsOfOwners()

ILIAS\Exercise\Submission\SubmissionManager::getSubmissionsOfOwners ( array $user_ids )

This is only suitable for types like text or single upload, where no teams are used.

Returns: \Generator<Submission>

Definition at line 110 of file SubmissionManager.php.

                                                           : \Generator
    {
        $type_uses_uploads = $this->type->usesFileUpload();
        $type_uses_print_versions = in_array($this->assignment->getType(), [
            \ilExAssignment::TYPE_BLOG,
            \ilExAssignment::TYPE_PORTFOLIO,
            \ilExAssignment::TYPE_WIKI_TEAM
        ], true);
        yield from $this->repo->getSubmissionsOfUsers(
            $this->ass_id,
            $type_uses_uploads,
            $type_uses_print_versions,
            $user_ids
        );
    }

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, and ilExAssignment\TYPE_WIKI_TEAM.

Here is the call graph for this function:

◆ getSubmissionsOfUser()

ILIAS\Exercise\Submission\SubmissionManager::getSubmissionsOfUser	(	int	$user_id,
		?array	$submit_ids = `null`,
		bool	$only_valid = `false`,
		?string	$min_timestamp = `null`,
		bool	$print_versions = `false`
	)

Note: this includes submissions of other team members, if user is in a team.

Returns: \Generator<Submission>

Definition at line 60 of file SubmissionManager.php.

     : \Generator {
        $type_uses_print_versions = in_array($this->assignment->getType(), [
            \ilExAssignment::TYPE_BLOG,
            \ilExAssignment::TYPE_PORTFOLIO,
            \ilExAssignment::TYPE_WIKI_TEAM
        ], true);
        $type_uses_uploads = $this->type->usesFileUpload();
        if ($this->type->isSubmissionAssignedToTeam()) {
            $team_id = $this->team->getTeamForMember($this->ass_id, $user_id);
            if (((int) $team_id) !== 0) {
                yield from $this->repo->getSubmissionsOfTeam(
                    $this->ass_id,
                    $type_uses_uploads,
                    $type_uses_print_versions,
                    $team_id,
                    $submit_ids,
                    $only_valid,
                    $min_timestamp,
                    $print_versions
                );
            }
        } else {
            $user_ids = $this->team->getTeamMemberIdsOrUserId(
                $this->ass_id,
                $user_id
            );
            yield from $this->repo->getSubmissionsOfUsers(
                $this->ass_id,
                $type_uses_uploads,
                $type_uses_print_versions,
                $user_ids,
                $submit_ids,
                $only_valid,
                $min_timestamp,
                $print_versions
            );
        }
        yield from [];
    }

References ILIAS\Exercise\Submission\Submission\$team_id, ILIAS\Exercise\Submission\Submission\$user_id, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Referenced by ILIAS\Exercise\Submission\SubmissionManager\countSubmissionsOfUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUsersWithSubmission()

ILIAS\Exercise\Submission\SubmissionManager::getUsersWithSubmission ( )

Get all user ids, that have submitted something.

Returns: int[]

Definition at line 198 of file SubmissionManager.php.

                                            : array
    {
        return $this->repo->getUsersWithSubmission(
            $this->ass_id
        );
    }

◆ recalculateLateSubmissions()

ILIAS\Exercise\Submission\SubmissionManager::recalculateLateSubmissions ( )

Definition at line 126 of file SubmissionManager.php.

                                                : void
    {
        // see JF, 2015-05-11
        $assigment = $this->assignment;
 
        $ext_deadline = $assigment->getExtendedDeadline();
 
        foreach ($this->getAllAssignmentFiles() as $file) {
            $id = $file["returned_id"];
            $uploaded = new \ilDateTime($file["ts"], IL_CAL_DATETIME);
            $uploaded = $uploaded->get(IL_CAL_UNIX);
 
            $deadline = $assigment->getPersonalDeadline($file["user_id"]);
            $last_deadline = max($deadline, $assigment->getExtendedDeadline());
 
            $late = null;
 
            // upload is not late anymore
            if ($file["late"] &&
                (!$last_deadline ||
                    !$ext_deadline ||
                    $uploaded < $deadline)) {
                $late = false;
            }
            // upload is now late
            elseif (!$file["late"] &&
                $ext_deadline &&
                $deadline &&
                $uploaded > $deadline) {
                $late = true;
            }
 
            if ($late !== null) {
                $this->repo->updateLate(
                    $id,
                    $late
                );
            }
        }
    }

References ILIAS\Exercise\Submission\Submission\$id, ILIAS\Exercise\Submission\Submission\$late, IL_CAL_DATETIME, and IL_CAL_UNIX.

◆ remainingFilesAllowed()

ILIAS\Exercise\Submission\SubmissionManager::remainingFilesAllowed ( int $user_id )

protected

Definition at line 303 of file SubmissionManager.php.

                                                          : int
    {
        $submission = new \ilExSubmission(
            $this->assignment,
            $user_id
        );
        $max_file = $submission->getAssignment()->getMaxFile();
        if ($max_file === 0) {
            return -1;
        }
        $cnt_sub = $this->countSubmissionsOfUser($user_id);
        $max_file -= $cnt_sub;
        return max($max_file, 0);
    }

References $user_id.

Field Documentation

◆ $assignment

ilExAssignment ILIAS\Exercise\Submission\SubmissionManager::$assignment

protected

Definition at line 34 of file SubmissionManager.php.

◆ $log

ilLogger ILIAS\Exercise\Submission\SubmissionManager::$log

protected

Definition at line 32 of file SubmissionManager.php.

◆ $repo

SubmissionRepositoryInterface ILIAS\Exercise\Submission\SubmissionManager::$repo

protected

Definition at line 33 of file SubmissionManager.php.

Referenced by ILIAS\Exercise\Submission\SubmissionManager\__construct().

◆ $team

ILIAS Exercise Team TeamManager ILIAS\Exercise\Submission\SubmissionManager::$team

protected

Definition at line 31 of file SubmissionManager.php.

◆ $type

ilExAssignmentTypeInterface ILIAS\Exercise\Submission\SubmissionManager::$type

protected

Definition at line 30 of file SubmissionManager.php.

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

components/ILIAS/Exercise/Submission/SubmissionManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLocalFile()

◆ addUpload()

◆ addZipUploads()

◆ copyRidToWebDir()

◆ copySubmissionsToDir()

◆ countSubmissionsOfUser()

◆ deleteAllSubmissionsOfUser()

◆ deleteSubmissions()

◆ deliverFile()

◆ getAllAssignmentFiles()

◆ getAllSubmissionIdsOfUser()

◆ getDirectoryNameFromUserData()

◆ getMaxAmountOfSubmittedFiles()

◆ getSubmissionsOfOwners()

◆ getSubmissionsOfUser()

◆ getUsersWithSubmission()

◆ recalculateLateSubmissions()

◆ remainingFilesAllowed()

Field Documentation

◆ $assignment

◆ $log

◆ $repo

◆ $team

◆ $type