Exercise submission //TODO: This class has many static methods related to delivered "files". More...

Collaboration diagram for ilExSubmission:

Public Member Functions
	__construct (ilExAssignment $a_ass, int $a_user_id, ?ilExAssignmentTeam $a_team=null, bool $a_is_tutor=false, bool $a_public_submissions=false)

	getSubmissionType ()

	getAssignment ()

	getTeam ()

	getPeerReview ()

	validatePeerReviews ()

	getUserId ()

	getUserIds ()

	getFeedbackId ()
	used for the legacy storage path of feedbacks only More...

	hasSubmitted ()

	hasSubmittedPrintVersion ()

	getSubmittedEntry (bool $print=false)

	getSelectedObject ()

	canSubmit ()

	canView ()

	isTutor ()

	hasNoTeamYet ()

	isInTeam (?int $a_user_id=null)

	isOwner ()

	hasPeerReviewAccess ()

	canAddFile ()

	isLate ()

	lookupNewFiles (?int $a_tutor=null)
	Check how much files have been uploaded by the learner after the last download of the tutor. More...

	deleteAllFiles ()

	updateTutorDownloadTime ()

	getTableUserWhere ()

	getLastSubmission ()
	TODO -> get rid of getTableUserWhere and move to repository class Get the date of the last submission of a user for the assignment. More...

	getLastOpeningHTMLView ()
	TODO -> get rid of getTableUserWhere and move to repository class Get a mysql timestamp from the last HTML view opening. More...

	addResourceObject (string $a_wsp_id, ?string $a_text=null)
	Add personal resource or repository object (ref_id) to assigment. More...

	deleteResourceObject ()

	updateTextSubmission (string $a_text)
	Handle text assignment submissions. More...

Static Public Member Functions
static	lookupExerciseIdForReturnedId (int $a_returned_id)
	Get exercise from submission id (used in ilObjMediaObject) More...

static	findUserFiles (int $a_user_id, string $a_filetitle)
	Check if given file was assigned Used in Blog/Portfolio. More...

static	deleteUser (int $a_exc_id, int $a_user_id)
	Deletes already delivered files. More...

static	getSubmissionsForFilename (string $a_filename, array $a_assignment_types=array())
	Get assignment return entries for a filename. More...

static	getDirectoryNameFromUserData (int $a_user_id)

static	getAssignmentParticipants (int $a_exercise_id, int $a_ass_id)

static	processZipFile (string $a_directory, string $a_file, bool $structure)

Data Fields
const	TYPE_FILE = "File"

const	TYPE_OBJECT = "Object"

const	TYPE_TEXT = "Text"

const	TYPE_REPO_OBJECT = "RepoObject"

Protected Member Functions
	getStorageId ()

	getLastDownloadTime (array $a_user_ids)

	downloadSingleFile (Submission $sub, string $title)

Protected Attributes
ILIAS Exercise Submission SubmissionManager	$sub_manager

ILIAS Exercise InternalDomainService	$domain

ilObjUser	$user

ilDBInterface	$db

ilLanguage	$lng

ilCtrl	$ctrl

ilExAssignment	$assignment

int	$user_id

ilExAssignmentTeam	$team = null

ilExPeerReview	$peer_review = null

bool	$is_tutor

bool	$public_submissions

ilExAssignmentTypeInterface	$ass_type

ilExAssignmentTypes	$ass_types

ilExcAssMemberState	$state

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Exercise submission //TODO: This class has many static methods related to delivered "files".

Extract them to classes.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilExSubmission::__construct	(	ilExAssignment	$a_ass,
		int	$a_user_id,
		?ilExAssignmentTeam	$a_team = `null`,
		bool	$a_is_tutor = `false`,
		bool	$a_public_submissions = `false`
	)

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

      {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
 
        $this->user = $DIC->user();
        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
 
        $this->assignment = $a_ass;
        $this->ass_type = $this->assignment->getAssignmentType();
        $this->ass_types = ilExAssignmentTypes::getInstance();
 
        $this->user_id = $a_user_id;
        $this->is_tutor = $a_is_tutor;
        $this->public_submissions = $a_public_submissions;
 
        $this->state = ilExcAssMemberState::getInstanceByIds($a_ass->getId(), $a_user_id);
 
        if ($a_ass->hasTeam()) {        // ass type uses teams...
            if (!$a_team) {
                // this might be a team with no id (since the create on demand parameter is not set)
                $this->team = ilExAssignmentTeam::getInstanceByUserId($this->assignment->getId(), $this->user_id);
            } else {
                $this->team = $a_team;
            }
        }
 
        if ($this->assignment->getPeerReview()) {
            $this->peer_review = new ilExPeerReview($this->assignment);
        }
        $this->domain = $DIC->exercise()->internal()->domain();
        $this->sub_manager = $DIC->exercise()->internal()->domain()->submission(
            $a_ass->getId()
        );
    }

References $DIC, ILIAS\Repository\ctrl(), ilExAssignment\getAssignmentType(), ilExAssignment\getId(), ilExAssignmentTypes\getInstance(), ilExcAssMemberState\getInstanceByIds(), ilExAssignmentTeam\getInstanceByUserId(), ilExAssignment\hasTeam(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addResourceObject()

ilExSubmission::addResourceObject	(	string	$a_wsp_id,
		?string	$a_text = `null`
	)

Add personal resource or repository object (ref_id) to assigment.

Exceptions

ilExcUnknownAssignmentTypeException
ilExerciseException

Definition at line 693 of file class.ilExSubmission.php.

     : int {
        $ilDB = $this->db;
 
        if ($this->getAssignment()->getAssignmentType()->isSubmissionAssignedToTeam()) {
            $user_id = 0;
            $team_id = $this->getTeam()->getId();
        } else {
            $user_id = $this->getUserId();
            $team_id = 0;
        }
 
        // repository objects must be unique in submissions
        // the same repo object cannot be used in different submissions or even different assignment/exercises
        // why? -> the access handling would fail, since the access depends e.g. on teams or even phase of the
        // assignment
        if ($this->getAssignment()->getAssignmentType()->getSubmissionType() == ilExSubmission::TYPE_REPO_OBJECT) {
            $repos_ass_type_ids = $this->ass_types->getIdsForSubmissionType(ilExSubmission::TYPE_REPO_OBJECT);
            $subs = $this->getSubmissionsForFilename($a_wsp_id, $repos_ass_type_ids);
            if ($subs !== []) {
                throw new ilExerciseException("Repository object $a_wsp_id is already assigned to another assignment.");
            }
        }
 
        $next_id = $ilDB->nextId("exc_returned");
        $query = sprintf(
            "INSERT INTO exc_returned " .
                         "(returned_id, obj_id, user_id, filetitle, ass_id, ts, atext, late, team_id) " .
                         "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)",
            $ilDB->quote($next_id, "integer"),
            $ilDB->quote($this->assignment->getExerciseId(), "integer"),
            $ilDB->quote($user_id, "integer"),
            $ilDB->quote($a_wsp_id, "text"),
            $ilDB->quote($this->assignment->getId(), "integer"),
            $ilDB->quote(ilUtil::now(), "timestamp"),
            $ilDB->quote($a_text, "text"),
            $ilDB->quote($this->isLate(), "integer"),
            $ilDB->quote($team_id, "integer")
        );
        $ilDB->manipulate($query);
 
        return $next_id;
    }

References $user_id.

◆ canAddFile()

ilExSubmission::canAddFile ( )

Definition at line 256 of file class.ilExSubmission.php.

                                : bool
    {
        if (!$this->canSubmit()) {
            return false;
        }
 
        $max = $this->getAssignment()->getMaxFile();
        $cnt_sub = $this->sub_manager->countSubmissionsOfUser(
            $this->getUserId()
        );
        if ($max &&
            $max <= $cnt_sub) {
            return false;
        }
 
        return true;
    }

References canSubmit(), getAssignment(), and getUserId().

Here is the call graph for this function:

◆ canSubmit()

ilExSubmission::canSubmit ( )

Definition at line 189 of file class.ilExSubmission.php.

                               : bool
    {
        return ($this->isOwner() &&
            $this->state->isSubmissionAllowed());
    }

References isOwner().

Referenced by canAddFile(), canView(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), and ilExAssTypeWikiTeamGUI\renderOverviewContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canView()

ilExSubmission::canView ( )

Definition at line 195 of file class.ilExSubmission.php.

                             : bool
    {
        $ilUser = $this->user;
 
        if ($this->canSubmit() ||
            $this->isTutor() ||
            $this->isInTeam() ||
            $this->public_submissions) {
            return true;
        }
 
        // #16115
        if ($this->peer_review) {
            // peer review givers may view peer submissions
            foreach ($this->peer_review->getPeerReviewsByPeerId($this->getUserId()) as $giver) {
                if ($giver["giver_id"] == $ilUser->getId()) {
                    return true;
                }
            }
        }
 
        return false;
    }

References $user, canSubmit(), isInTeam(), and isTutor().

Here is the call graph for this function:

◆ deleteAllFiles()

ilExSubmission::deleteAllFiles ( )

Definition at line 370 of file class.ilExSubmission.php.

                                    : void
    {
        $this->sub_manager->deleteAllSubmissionsOfUser($this->getUserId());
    }

◆ deleteResourceObject()

ilExSubmission::deleteResourceObject ( )

Definition at line 743 of file class.ilExSubmission.php.

                                          : void
    {
        $this->deleteAllFiles();
    }

Referenced by ilExSubmissionObjectGUI\getOverviewContentPortfolio(), and ilExAssTypeWikiTeamGUI\renderOverviewContent().

Here is the caller graph for this function:

◆ deleteUser()

static ilExSubmission::deleteUser	(	int	$a_exc_id,
		int	$a_user_id
	)

static

Deletes already delivered files.

Parameters

array $file_id_array An array containing database ids of the delivered files Delete all delivered files of user

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 441 of file class.ilExSubmission.php.

     : void {
        global $DIC;
 
        $db = $DIC->database();
 
        foreach (ilExAssignment::getInstancesByExercise($a_exc_id) as $ass) {
            $submission = new self($ass, $a_user_id);
            $submission->deleteAllFiles();
 
            // remove from any team
            $team = $submission->getTeam();
            if ($team) {
                $team->removeTeamMember($a_user_id);
            }
 
            // #14900
            if (\ilObject::_lookupType($ass->getExerciseId()) === "exc") {  // see #45183
                $member_status = $ass->getMemberStatus($a_user_id);
                $member_status->setStatus("notgraded");
                $member_status->update();
            }
 
            $db->manipulateF(
                "DELETE FROM exc_usr_tutor " .
                "WHERE ass_id = %s AND usr_id = %s",
                array("integer", "integer"),
                array($ass->getId(), $a_user_id)
            );
        }
    }

References ilObject\_lookupType(), ilDBInterface\manipulateF(), and ilExAssignmentTeam\removeTeamMember().

Referenced by ilExerciseMembers\deassignMember(), and ILIAS\Exercise\User\UserEvent\handleDeletion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadSingleFile()

ilExSubmission::downloadSingleFile	(	Submission	$sub,
		string	$title
	)

protected

Definition at line 614 of file class.ilExSubmission.php.

     : void {
        $this->domain->submission($this->assignment->getId())->deliverFile(
            $sub->getUserId(),
            $sub->getRid(),
            $title
        );
    }

◆ findUserFiles()

static ilExSubmission::findUserFiles	(	int	$a_user_id,
		string	$a_filetitle
	)

static

Check if given file was assigned Used in Blog/Portfolio.

Definition at line 351 of file class.ilExSubmission.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT obj_id, ass_id" .
            " FROM exc_returned" .
            " WHERE user_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND filetitle = " . $ilDB->quote($a_filetitle, "text"));
        $res = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[$row["ass_id"]] = $row;
        }
        return $res;
    }

Referenced by ILIAS\Blog\Exercise\BlogExercise\getAssignmentsOfBlog(), and ilPortfolioExercise\getAssignmentsOfPortfolio().

Here is the caller graph for this function:

◆ getAssignment()

ilExSubmission::getAssignment ( )

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

                                   : ilExAssignment
    {
        return $this->assignment;
    }

References $assignment.

Referenced by ilExSubmissionBaseGUI\__construct(), ilExSubmissionFileGUI\__construct(), ilExSubmissionTextGUI\__construct(), ilExPeerReviewGUI\buildSubmissionPropertiesAndActions(), ilExSubmissionTeamGUI\buildSubmissionPropertiesAndActions(), canAddFile(), and setSubmission().

Here is the caller graph for this function:

◆ getAssignmentParticipants()

static ilExSubmission::getAssignmentParticipants	(	int	$a_exercise_id,
		int	$a_ass_id
	)

static

Definition at line 988 of file class.ilExSubmission.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $participants = array();
        $query = "SELECT user_id FROM exc_returned WHERE ass_id = " .
            $ilDB->quote($a_ass_id, "integer") .
            " AND obj_id = " .
            $ilDB->quote($a_exercise_id, "integer");
 
        $res = $ilDB->query($query);
 
        while ($row = $ilDB->fetchAssoc($res)) {
            $participants[] = $row['user_id'];
        }
 
        return $participants;
    }

◆ getDirectoryNameFromUserData()

static ilExSubmission::getDirectoryNameFromUserData ( int $a_user_id )

static

Deprecated:: see getDirectoryNameFromUserData in SubmissionManager

Definition at line 977 of file class.ilExSubmission.php.

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

References ilObjUser\_lookupName(), and ilFileUtils\getASCIIFilename().

Referenced by ilExerciseManagementCollectFilesJob\createTargetDirectory(), ilExerciseManagementCollectFilesJob\getFeedbackDirectory(), and ilDownloadSubmissionsBackgroundTask\run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFeedbackId()

ilExSubmission::getFeedbackId ( )

used for the legacy storage path of feedbacks only

Definition at line 150 of file class.ilExSubmission.php.

                                   : string
    {
        if ($this->team) {
            return "t" . $this->team->getId();
        } else {
            return (string) $this->getUserId();
        }
    }

References getUserId().

Here is the call graph for this function:

◆ getLastDownloadTime()

ilExSubmission::getLastDownloadTime ( array $a_user_ids )

protected

Parameters

array $a_user_ids

Returns: string "Y-m-d H:i:s"

Definition at line 479 of file class.ilExSubmission.php.

     : string {
        $ilDB = $this->db;
        $ilUser = $this->user;
 
        $q = "SELECT download_time FROM exc_usr_tutor WHERE " .
            " ass_id = " . $ilDB->quote($this->getAssignment()->getId(), "integer") . " AND " .
            $ilDB->in("usr_id", $a_user_ids, "", "integer") . " AND " .
            " tutor_id = " . $ilDB->quote($ilUser->getId(), "integer") .
            " ORDER BY download_time DESC";
        $lu_set = $ilDB->query($q);
        $lu_rec = $ilDB->fetchAssoc($lu_set);
        return $lu_rec["download_time"] ?? "";
    }

◆ getLastOpeningHTMLView()

ilExSubmission::getLastOpeningHTMLView ( )

TODO -> get rid of getTableUserWhere and move to repository class Get a mysql timestamp from the last HTML view opening.

Definition at line 665 of file class.ilExSubmission.php.

                                            : ?string
    {
        $this->db->setLimit(1, 0);
 
        $q = "SELECT web_dir_access_time FROM exc_returned" .
            " WHERE ass_id = " . $this->db->quote($this->assignment->getId(), "integer") .
            " AND (filename IS NOT NULL OR atext IS NOT NULL)" .
            " AND web_dir_access_time IS NOT NULL" .
            " AND " . $this->getTableUserWhere() .
            " ORDER BY web_dir_access_time DESC";
 
        $res = $this->db->query($q);
 
        $data = $this->db->fetchAssoc($res);
 
        return $data["web_dir_access_time"] ?? null;
    }

References $data, $q, and $res.

◆ getLastSubmission()

ilExSubmission::getLastSubmission ( )

TODO -> get rid of getTableUserWhere and move to repository class Get the date of the last submission of a user for the assignment.

Definition at line 644 of file class.ilExSubmission.php.

                                       : ?string
    {
        $ilDB = $this->db;
 
        $ilDB->setLimit(1, 0);
 
        $q = "SELECT obj_id,user_id,ts FROM exc_returned" .
            " WHERE ass_id = " . $ilDB->quote($this->assignment->getId(), "integer") .
            " AND " . $this->getTableUserWhere() .
            " AND (filename IS NOT NULL OR atext IS NOT NULL)" .
            " AND ts IS NOT NULL" .
            " ORDER BY ts DESC";
        $usr_set = $ilDB->query($q);
        $array = $ilDB->fetchAssoc($usr_set);
        return ($array["ts"] ?? null);
    }

References $ilDB, and $q.

Referenced by ilExSubmissionTeamGUI\buildSubmissionPropertiesAndActions().

Here is the caller graph for this function:

◆ getPeerReview()

ilExSubmission::getPeerReview ( )

Definition at line 110 of file class.ilExSubmission.php.

                                   : ?ilExPeerReview
    {
        return $this->peer_review;
    }

References $peer_review.

Referenced by ilExPeerReviewGUI\buildSubmissionPropertiesAndActions(), and ilExPeerReviewGUI\getPeerReviewReceiverPanel().

Here is the caller graph for this function:

◆ getSelectedObject()

ilExSubmission::getSelectedObject ( )

Definition at line 184 of file class.ilExSubmission.php.

                                       : ?Submission
    {
        return $this->sub_manager->getSubmissionsOfUser($this->getUserId())->current();
    }

References getUserId().

Referenced by ilExSubmissionObjectGUI\getOverviewContentPortfolio(), and ilExAssTypeWikiTeamGUI\renderOverviewContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStorageId()

ilExSubmission::getStorageId ( )

protected

Definition at line 286 of file class.ilExSubmission.php.

                                     : int
    {
        if ($this->ass_type->isSubmissionAssignedToTeam()) {
            $storage_id = $this->getTeam()->getId();
        } else {
            $storage_id = $this->getUserId();
        }
        return $storage_id;
    }

References getTeam(), and getUserId().

Here is the call graph for this function:

◆ getSubmissionsForFilename()

static ilExSubmission::getSubmissionsForFilename	(	string	$a_filename,
		array	$a_assignment_types = `array()`
	)

static

Get assignment return entries for a filename.

Definition at line 948 of file class.ilExSubmission.php.

     : array {
        global $DIC;
 
        $db = $DIC->database();
 
        $query = "SELECT * FROM exc_returned r LEFT JOIN exc_assignment a" .
            " ON (r.ass_id = a.id) " .
            " WHERE r.filetitle = " . $db->quote($a_filename, "string");
 
        if (is_array($a_assignment_types) && $a_assignment_types !== []) {
            $query .= " AND " . $db->in("a.type", $a_assignment_types, false, "integer");
        }
 
        $set = $db->query($query);
        $rets = array();
        while ($rec = $db->fetchAssoc($set)) {
            $rets[] = $rec;
        }
 
 
        return $rets;
    }

References ilDBInterface\in().

Referenced by ilExcRepoObjAssignmentInfo\getInfo(), and ilObjWikiListGUI\getProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubmissionType()

ilExSubmission::getSubmissionType ( )

Definition at line 95 of file class.ilExSubmission.php.

                                       : string
    {
        return $this->assignment->getAssignmentType()->getSubmissionType();
    }

◆ getSubmittedEntry()

ilExSubmission::getSubmittedEntry ( bool $print = false )

Definition at line 173 of file class.ilExSubmission.php.

                                                          : ?Submission
    {
        return $this->sub_manager->getSubmissionsOfUser(
            $this->getUserId(),
            null,
            false,
            null,
            $print
        )->current();
    }

References getUserId().

Referenced by hasSubmittedPrintVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableUserWhere()

ilExSubmission::getTableUserWhere ( )

Definition at line 626 of file class.ilExSubmission.php.

                                       : string
    {
        $ilDB = $this->db;
 
        if ($this->getAssignment()->getAssignmentType()->isSubmissionAssignedToTeam()) {
            $team_id = $this->getTeam()->getId();
            $where = " team_id = " . $ilDB->quote($team_id, "integer") . " ";
        } else {
            $where = " " . $ilDB->in("user_id", $this->getUserIds(), "", "integer") . " ";
        }
        return $where;
    }

References $ilDB.

◆ getTeam()

ilExSubmission::getTeam ( )

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

                             : ?ilExAssignmentTeam
    {
        return $this->team;
    }

References $team.

Referenced by ilExSubmissionTeamGUI\buildSubmissionPropertiesAndActions(), getStorageId(), and ilExAssTypeWikiTeamGUI\renderOverviewContent().

Here is the caller graph for this function:

◆ getUserId()

ilExSubmission::getUserId ( )

Definition at line 131 of file class.ilExSubmission.php.

                               : int
    {
        return $this->user_id;
    }

References $user_id.

Referenced by ilExcDeliveredFilesTableGUI\__construct(), ilExPeerReviewGUI\buildSubmissionPropertiesAndActions(), ilExSubmissionTeamGUI\buildSubmissionPropertiesAndActions(), canAddFile(), getFeedbackId(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), getSelectedObject(), getStorageId(), getSubmittedEntry(), hasSubmitted(), and setSubmission().

Here is the caller graph for this function:

◆ getUserIds()

ilExSubmission::getUserIds ( )

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

                                : array
    {
        if ($this->team &&
            !$this->hasNoTeamYet()) {
            return $this->team->getMembers();
        }
 
        // if has no team currently there still might be uploads attached
        return array($this->user_id);
    }

References hasNoTeamYet().

Referenced by isInTeam(), and validatePeerReviews().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasNoTeamYet()

ilExSubmission::hasNoTeamYet ( )

Definition at line 224 of file class.ilExSubmission.php.

                                  : bool
    {
        if ($this->assignment->hasTeam() &&
            !$this->team->getId()) {
            return true;
        }
        return false;
    }

Referenced by getUserIds().

Here is the caller graph for this function:

◆ hasPeerReviewAccess()

ilExSubmission::hasPeerReviewAccess ( )

Definition at line 250 of file class.ilExSubmission.php.

                                         : bool
    {
        return ($this->peer_review &&
            $this->peer_review->hasPeerReviewAccess($this->user_id));
    }

◆ hasSubmitted()

ilExSubmission::hasSubmitted ( )

Definition at line 159 of file class.ilExSubmission.php.

                                  : bool
    {
        return (bool) $this->sub_manager->getSubmissionsOfUser(
            $this->getUserId(),
            null,
            true
        )->current();
    }

References getUserId().

Referenced by ilExSubmissionTeamGUI\buildSubmissionPropertiesAndActions(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), ilExcAssMemberState\isGlobalFeedbackFileAccessible(), and ilExAssTypeWikiTeamGUI\renderOverviewContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasSubmittedPrintVersion()

ilExSubmission::hasSubmittedPrintVersion ( )

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

                                              : bool
    {
        return ($this->getSubmittedEntry(true)?->getRid() != "");
    }

References getSubmittedEntry().

Here is the call graph for this function:

◆ isInTeam()

ilExSubmission::isInTeam ( ?int $a_user_id = null )

Definition at line 233 of file class.ilExSubmission.php.

                                                    : bool
    {
        $ilUser = $this->user;
 
        if (!$a_user_id) {
            $a_user_id = $ilUser->getId();
        }
        return in_array($a_user_id, $this->getUserIds());
    }

References $user, ilObject\getId(), and getUserIds().

Referenced by canView().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLate()

ilExSubmission::isLate ( )

Definition at line 279 of file class.ilExSubmission.php.

                            : bool
    {
        $dl = $this->state->getOfficialDeadline();
        //$dl = $this->assignment->getPersonalDeadline($this->getUserId());
        return ($dl && $dl < time());
    }

◆ isOwner()

ilExSubmission::isOwner ( )

Definition at line 243 of file class.ilExSubmission.php.

                             : bool
    {
        $ilUser = $this->user;
 
        return ($ilUser->getId() == $this->getUserId());
    }

References $user.

Referenced by canSubmit().

Here is the caller graph for this function:

◆ isTutor()

ilExSubmission::isTutor ( )

Definition at line 219 of file class.ilExSubmission.php.

                             : bool
    {
        return $this->is_tutor;
    }

References $is_tutor.

Referenced by canView().

Here is the caller graph for this function:

◆ lookupExerciseIdForReturnedId()

static ilExSubmission::lookupExerciseIdForReturnedId ( int $a_returned_id )

static

Get exercise from submission id (used in ilObjMediaObject)

Definition at line 333 of file class.ilExSubmission.php.

     : int {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT obj_id" .
            " FROM exc_returned" .
            " WHERE returned_id = " . $ilDB->quote($a_returned_id, "integer"));
        $row = $ilDB->fetchAssoc($set);
        return (int) $row["obj_id"];
    }

◆ lookupNewFiles()

ilExSubmission::lookupNewFiles ( ?int $a_tutor = null )

Check how much files have been uploaded by the learner after the last download of the tutor.

Definition at line 300 of file class.ilExSubmission.php.

     : array {
        $ilDB = $this->db;
        $ilUser = $this->user;
 
        $tutor = ($a_tutor)
            ?: $ilUser->getId();
 
        $where = " AND " . $this->getTableUserWhere();
 
        $q = "SELECT exc_returned.returned_id AS id " .
            "FROM exc_usr_tutor, exc_returned " .
            "WHERE exc_returned.ass_id = exc_usr_tutor.ass_id " .
            " AND exc_returned.user_id = exc_usr_tutor.usr_id " .
            " AND exc_returned.ass_id = " . $ilDB->quote($this->getAssignment()->getId(), "integer") .
            $where .
            " AND exc_usr_tutor.tutor_id = " . $ilDB->quote($tutor, "integer") .
            " AND exc_usr_tutor.download_time < exc_returned.ts ";
 
        $new_up_set = $ilDB->query($q);
 
        $new_up = array();
        while ($new_up_rec = $ilDB->fetchAssoc($new_up_set)) {
            $new_up[] = $new_up_rec["id"];
        }
 
        return $new_up;
    }

◆ processZipFile()

static ilExSubmission::processZipFile	(	string	$a_directory,
		string	$a_file,
		bool	$structure
	)

static

Definition at line 1011 of file class.ilExSubmission.php.

     : void {
        global $DIC;
 
        $lng = $DIC->language();
 
        $pathinfo = pathinfo($a_file);
        $file = $pathinfo["basename"];
 
        // see 22727
        if (($pathinfo["extension"] ?? '') === '') {
            $file .= ".zip";
        }
 
        // Copy zip-file to new directory, unzip and remove it
        // TODO: check archive for broken file
        //copy ($a_file, $a_directory . "/" . $file);
        ilFileUtils::moveUploadedFile($a_file, $file, $a_directory . "/" . $file);
        $DIC->legacyArchives()->unzip(
            $a_directory . "/" . $file,
            null,
            false,
            true,
            false
        );
        unlink($a_directory . "/" . $file);
        //echo "-".$a_directory . "/" . $file."-";
        // Stores filename and paths into $filearray to check for viruses
        // Checks if filenames can be read, else -> throw exception and leave
        $filearray = [];
        ilFileUtils::recursive_dirscan($a_directory, $filearray);
 
        // if there are no files unziped (->broken file!)
        if (empty($filearray)) {
            throw new ilFileUtilsException(
                $lng->txt("archive_broken"),
                ilFileUtilsException::$BROKEN_FILE
            );
        }
 
        // virus handling
        foreach ($filearray["file"] as $key => $value) {
            // remove "invisible" files
            if (substr($value, 0, 1) == "." || stristr(
                $filearray["path"][$key],
                "/__MACOSX/"
            )) {
                unlink($filearray["path"][$key] . $value);
                unset($filearray["path"][$key]);
                unset($filearray["file"][$key]);
                continue;
            }
 
            $vir = ilVirusScanner::virusHandling($filearray["path"][$key], $value);
            if (!$vir[0]) {
                // Unlink file and throw exception
                unlink($filearray['path'][$key]);
                throw new ilFileUtilsException(
                    $lng->txt("file_is_infected") . "<br />" . $vir[1],
                    ilFileUtilsException::$INFECTED_FILE
                );
            } elseif ($vir[1] != "") {
                throw new ilFileUtilsException(
                    $vir[1],
                    ilFileUtilsException::$INFECTED_FILE
                );
            }
        }
 
        // If archive is to be used "flat"
        $doublettes = '';
        if (!$structure) {
            foreach (array_count_values($filearray["file"]) as $key => $value) {
                // Archive contains same filenames in different directories
                if ($value != "1") {
                    $doublettes .= " '" . ilFileUtils::utf8_encode($key) . "'";
                }
            }
            if (strlen($doublettes) > 0) {
                throw new ilFileUtilsException(
                    $lng->txt("exc_upload_error") . "<br />" . $lng->txt(
                        "zip_structure_error"
                    ) . $doublettes,
                    ilFileUtilsException::$DOUBLETTES_FOUND
                );
            }
        } else {
            $mac_dir = $a_directory . "/__MACOSX";
            if (file_exists($mac_dir)) {
                ilFileUtils::delDir($mac_dir);
            }
        }
    }

◆ updateTextSubmission()

ilExSubmission::updateTextSubmission ( string $a_text )

Handle text assignment submissions.

Exceptions

ilExcUnknownAssignmentTypeException
ilExerciseException

Definition at line 753 of file class.ilExSubmission.php.

                                                        : ?int
    {
        $ilDB = $this->db;
 
        // no text = remove submission
        if (!trim($a_text)) {
            $this->sub_manager->deleteAllSubmissionsOfUser($this->getUserId());
            return null;
        }
 
        $sub = $this->sub_manager->getSubmissionsOfUser($this->getUserId())->current();
 
        if (!$sub) {
            return $this->addResourceObject("TEXT", $a_text);
        } else {
            $id = $sub->getId();
            if ($id) {
                $ilDB->manipulate("UPDATE exc_returned" .
                    " SET atext = " . $ilDB->quote($a_text, "text") .
                    ", ts = " . $ilDB->quote(ilUtil::now(), "timestamp") .
                    ", late = " . $ilDB->quote($this->isLate(), "integer") .
                    " WHERE returned_id = " . $ilDB->quote($id, "integer"));
                return $id;
            }
        }
        return null;
    }

References $id, $ilDB, and ilUtil\now().

Here is the call graph for this function:

◆ updateTutorDownloadTime()

ilExSubmission::updateTutorDownloadTime ( )

Definition at line 589 of file class.ilExSubmission.php.

                                             : void
    {
        $ilUser = $this->user;
        $ilDB = $this->db;
 
        $exc_id = $this->assignment->getExerciseId();
        $ass_id = $this->assignment->getId();
 
        foreach ($this->getUserIds() as $user_id) {
            $ilDB->manipulateF(
                "DELETE FROM exc_usr_tutor " .
                "WHERE ass_id = %s AND usr_id = %s AND tutor_id = %s",
                array("integer", "integer", "integer"),
                array($ass_id, $user_id, $ilUser->getId())
            );
 
            $ilDB->manipulateF(
                "INSERT INTO exc_usr_tutor (ass_id, obj_id, usr_id, tutor_id, download_time) VALUES " .
                "(%s, %s, %s, %s, %s)",
                array("integer", "integer", "integer", "integer", "timestamp"),
                array($ass_id, $exc_id, $user_id, $ilUser->getId(), ilUtil::now())
            );
        }
    }

References $ass_id, $ilDB, $user_id, and ilUtil\now().

Here is the call graph for this function:

◆ validatePeerReviews()

ilExSubmission::validatePeerReviews ( )

Definition at line 115 of file class.ilExSubmission.php.

                                         : array
    {
        $res = array();
        foreach ($this->getUserIds() as $user_id) {
            $valid = true;
 
            // no peer review == valid
            if ($this->peer_review) {
                $valid = $this->peer_review->isFeedbackValidForPassed($user_id);
            }
 
            $res[$user_id] = $valid;
        }
        return $res;
    }

References $res, $user_id, $valid, and getUserIds().

Here is the call graph for this function:

Field Documentation

◆ $ass_type

ilExAssignmentTypeInterface ilExSubmission::$ass_type

protected

Definition at line 47 of file class.ilExSubmission.php.

◆ $ass_types

ilExAssignmentTypes ilExSubmission::$ass_types

protected

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

◆ $assignment

ilExAssignment ilExSubmission::$assignment

protected

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

Referenced by getAssignment().

◆ $ctrl

ilCtrl ilExSubmission::$ctrl

protected

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

◆ $db

ilDBInterface ilExSubmission::$db

protected

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

◆ $domain

ILIAS Exercise InternalDomainService ilExSubmission::$domain

protected

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

◆ $is_tutor

bool ilExSubmission::$is_tutor

protected

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

Referenced by isTutor().

◆ $lng

ilLanguage ilExSubmission::$lng

protected

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

◆ $main_tpl

ilGlobalTemplateInterface ilExSubmission::$main_tpl

private

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

◆ $peer_review

ilExPeerReview ilExSubmission::$peer_review = null

protected

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

Referenced by getPeerReview().

◆ $public_submissions

bool ilExSubmission::$public_submissions

protected

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

◆ $state

ilExcAssMemberState ilExSubmission::$state

protected

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

◆ $sub_manager

ILIAS Exercise Submission SubmissionManager ilExSubmission::$sub_manager

protected

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

◆ $team

ilExAssignmentTeam ilExSubmission::$team = null

protected

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

Referenced by getTeam().

◆ $user

ilObjUser ilExSubmission::$user

protected

Definition at line 37 of file class.ilExSubmission.php.

Referenced by canView(), isInTeam(), and isOwner().

◆ $user_id

int ilExSubmission::$user_id

protected

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

Referenced by getUserId(), and validatePeerReviews().

◆ TYPE_FILE

const ilExSubmission::TYPE_FILE = "File"

Definition at line 30 of file class.ilExSubmission.php.

Referenced by ilExAssTypeUpload\getSubmissionType(), and ilExAssTypeUploadTeam\getSubmissionType().

◆ TYPE_OBJECT

const ilExSubmission::TYPE_OBJECT = "Object"

Definition at line 31 of file class.ilExSubmission.php.

Referenced by ilExAssTypeBlog\getSubmissionType(), and ilExAssTypePortfolio\getSubmissionType().

◆ TYPE_REPO_OBJECT

const ilExSubmission::TYPE_REPO_OBJECT = "RepoObject"

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

Referenced by ilExSubmissionGUI\executeCommand(), ilExcRepoObjAssignmentInfo\getInfo(), and ilExAssTypeWikiTeam\getSubmissionType().

◆ TYPE_TEXT

const ilExSubmission::TYPE_TEXT = "Text"

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

Referenced by ilExAssTypeText\getSubmissionType().

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

components/ILIAS/Exercise/Submission/class.ilExSubmission.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addResourceObject()

◆ canAddFile()

◆ canSubmit()

◆ canView()

◆ deleteAllFiles()

◆ deleteResourceObject()

◆ deleteUser()

◆ downloadSingleFile()

◆ findUserFiles()

◆ getAssignment()

◆ getAssignmentParticipants()

◆ getDirectoryNameFromUserData()

◆ getFeedbackId()

◆ getLastDownloadTime()

◆ getLastOpeningHTMLView()

◆ getLastSubmission()

◆ getPeerReview()

◆ getSelectedObject()

◆ getStorageId()

◆ getSubmissionsForFilename()

◆ getSubmissionType()

◆ getSubmittedEntry()

◆ getTableUserWhere()

◆ getTeam()

◆ getUserId()

◆ getUserIds()

◆ hasNoTeamYet()

◆ hasPeerReviewAccess()

◆ hasSubmitted()

◆ hasSubmittedPrintVersion()

◆ isInTeam()

◆ isLate()

◆ isOwner()

◆ isTutor()

◆ lookupExerciseIdForReturnedId()

◆ lookupNewFiles()

◆ processZipFile()

◆ updateTextSubmission()

◆ updateTutorDownloadTime()

◆ validatePeerReviews()

Field Documentation

◆ $ass_type

◆ $ass_types

◆ $assignment

◆ $ctrl

◆ $db

◆ $domain

◆ $is_tutor

◆ $lng

◆ $main_tpl

◆ $peer_review

◆ $public_submissions

◆ $state

◆ $sub_manager

◆ $team

◆ $user

◆ $user_id

◆ TYPE_FILE

◆ TYPE_OBJECT

◆ TYPE_REPO_OBJECT

◆ TYPE_TEXT