ILIAS\Exercise\Submission\SubmissionRepository Class Reference

Inheritance diagram for ILIAS\Exercise\Submission\SubmissionRepository:

Collaboration diagram for ILIAS\Exercise\Submission\SubmissionRepository:

Public Member Functions
	__construct (protected IRSSWrapper $irss, protected InternalDataService $data, ?\ilDBInterface $db=null)
	getAllEntriesOfAssignment (int $ass_id)
	getSubmissionsOfTeam (int $ass_id, bool $type_uses_uploads, bool $type_uses_print_versions, int $team_id, ?array $submit_ids=null, bool $only_valid=false, ?string $min_timestamp=null, bool $print_versions=false)
	getSubmissionsOfUsers (int $ass_id, bool $type_uses_uploads, bool $type_uses_print_versions, array $user_ids, ?array $submit_ids=null, bool $only_valid=false, ?string $min_timestamp=null, bool $print_versions=false)
	getById (int $id)
	getUserId (int $submission_id)
	getAllSubmissionIdsOfOwner (int $ass_id, int $user_id)
	hasSubmissions (int $assignment_id)
	updateWebDirAccessTime (int $assignment_id, int $member_id)
	getUserSubmissionState (int $user_id, array $assignment_ids)
	Checks if a user has submitted anything for a number of assignments. More...
	updateLate (int $return_id, bool $late)
	getMaxAmountOfSubmittedFiles (int $obj_id, int $ass_id, int $user_id=0)
	Get the number of max amount of files submitted by a single user in the assignment. More...
	getUsersWithSubmission (int $ass_id)
	Get all user ids, that have submitted something. More...
	addLocalFile (int $obj_id, int $ass_id, int $user_id, int $team_id, string $file, string $filename, bool $is_late, ResourceStakeholder $stakeholder)
	addUpload (int $obj_id, int $ass_id, int $user_id, int $team_id, UploadResult $result, string $filename, bool $is_late, ResourceStakeholder $stakeholder)
	addZipUpload (int $obj_id, int $ass_id, int $user_id, int $team_id, UploadResult $result, bool $is_late, ResourceStakeholder $stakeholder, int $remaining_allowed)
	delete (int $id, ResourceStakeholder $stakeholder)
	deliverFile (int $ass_id, int $user_id, string $rid, string $filetitle="")
	getStream (int $ass_id, string $rid)
	getUserId (int $submission_id)
	hasSubmissions (int $assignment_id)

Protected Member Functions
	getSubmissions (string $where, int $ass_id, bool $type_uses_uploads, bool $type_uses_print_versions, ?array $submit_ids=null, bool $only_valid=false, ?string $min_timestamp=null, bool $print_versions=false)
	getSubmissionFromRecord (array $rec)

Protected Attributes
const	TABLE_NAME = "exc_returned"
	$log
ilDBInterface	$db

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ILIAS\Exercise\Submission\SubmissionRepository::__construct	(	protected IRSSWrapper	$irss,
		protected InternalDataService	$data,
		?\ilDBInterface	$db = null
	)

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

      {
        global $DIC;
        $this->log = $DIC->logger()->exc();
        $this->db = (is_null($db))
            ? $DIC->database()
            : $db;
    }

References ILIAS\Exercise\Submission\SubmissionRepository\$db, and $DIC.

Member Function Documentation

addLocalFile()

ILIAS\Exercise\Submission\SubmissionRepository::addLocalFile	(	int	$obj_id,
		int	$ass_id,
		int	$user_id,
		int	$team_id,
		string	$file,
		string	$filename,
		bool	$is_late,
		ResourceStakeholder	$stakeholder
	)

Definition at line 341 of file class.SubmissionRepository.php.

     : bool {
        $db = $this->db;
        $rid = $this->irss->importLocalFile(
            $file,
            $filename,
            $stakeholder
        );
        $filename = \ilFileUtils::getValidFilename($filename);
 
        if ($rid !== "") {
            $info = $this->irss->getResourceInfo($rid);
            $next_id = $db->nextId("exc_returned");
            $query = sprintf(
                "INSERT INTO exc_returned " .
                "(returned_id, obj_id, user_id, filename, filetitle, mimetype, ts, ass_id, late, team_id, rid) " .
                "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                $db->quote($next_id, "integer"),
                $db->quote($obj_id, "integer"),
                $db->quote($user_id, "integer"),
                $db->quote($filename, "text"),
                $db->quote($filename, "text"),
                $db->quote($info->getMimeType(), "text"),
                $db->quote(\ilUtil::now(), "timestamp"),
                $db->quote($ass_id, "integer"),
                $db->quote($is_late, "integer"),
                $db->quote($team_id, "integer"),
                $db->quote($rid, "text")
            );
            $db->manipulate($query);
            return true;
        }
        return false;
    }

addUpload()

ILIAS\Exercise\Submission\SubmissionRepository::addUpload	(	int	$obj_id,
		int	$ass_id,
		int	$user_id,
		int	$team_id,
		UploadResult	$result,
		string	$filename,
		bool	$is_late,
		ResourceStakeholder	$stakeholder
	)

Definition at line 400 of file class.SubmissionRepository.php.

     : bool {
        $db = $this->db;
        $rid = $this->irss->importFileFromUploadResult(
            $result,
            $stakeholder
        );
        $filename = \ilFileUtils::getValidFilename($filename);
 
        if ($rid !== "") {
            $info = $this->irss->getResourceInfo($rid);
            $next_id = $db->nextId("exc_returned");
            $query = sprintf(
                "INSERT INTO exc_returned " .
                "(returned_id, obj_id, user_id, filename, filetitle, mimetype, ts, ass_id, late, team_id, rid) " .
                "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                $db->quote($next_id, "integer"),
                $db->quote($obj_id, "integer"),
                $db->quote($user_id, "integer"),
                $db->quote($filename, "text"),
                $db->quote($filename, "text"),
                $db->quote($info->getMimeType(), "text"),
                $db->quote(\ilUtil::now(), "timestamp"),
                $db->quote($ass_id, "integer"),
                $db->quote($is_late, "integer"),
                $db->quote($team_id, "integer"),
                $db->quote($rid, "text")
            );
            $db->manipulate($query);
            return true;
        }
        return false;
    }

addZipUpload()

ILIAS\Exercise\Submission\SubmissionRepository::addZipUpload	(	int	$obj_id,
		int	$ass_id,
		int	$user_id,
		int	$team_id,
		UploadResult	$result,
		bool	$is_late,
		ResourceStakeholder	$stakeholder,
		int	$remaining_allowed
	)

Exceptions

ilExcTooManyFilesSubmittedException

Definition at line 445 of file class.SubmissionRepository.php.

     : array {
        global $DIC;
 
        $db = $this->db;
        $filenames = [];
        $this->log->debug("5");
        $rid = $this->irss->importFileFromUploadResult(
            $result,
            $stakeholder
        );
        $this->log->debug("6");
        $stream = $this->irss->stream($rid);
 
        if ($remaining_allowed !== -1 &&
            $remaining_allowed < $DIC->archives()->unzip($stream)->getAmountOfFiles()) {
            throw new ilExcTooManyFilesSubmittedException("Too many files submitted.");
        }
 
        foreach ($DIC->archives()->unzip($stream)->getFileStreams() as $stream) {
            $this->log->debug("7");
            $rid = $this->irss->importStream(
                $stream,
                $stakeholder
            );
            $info = $this->irss->getResourceInfo($rid);
            $filename = $info->getTitle();
            $this->log->debug("8");
            if ($rid !== "") {
                $this->log->debug("9");
                $info = $this->irss->getResourceInfo($rid);
                $next_id = $db->nextId("exc_returned");
                $query = sprintf(
                    "INSERT INTO exc_returned " .
                    "(returned_id, obj_id, user_id, filename, filetitle, mimetype, ts, ass_id, late, team_id, rid) " .
                    "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                    $db->quote($next_id, "integer"),
                    $db->quote($obj_id, "integer"),
                    $db->quote($user_id, "integer"),
                    $db->quote($filename, "text"),
                    $db->quote($filename, "text"),
                    $db->quote($info->getMimeType(), "text"),
                    $db->quote(\ilUtil::now(), "timestamp"),
                    $db->quote($ass_id, "integer"),
                    $db->quote($is_late, "integer"),
                    $db->quote($team_id, "integer"),
                    $db->quote($rid, "text")
                );
                $db->manipulate($query);
                $filenames[] = $filename;
            }
        }
        return $filenames;
    }

delete()

ILIAS\Exercise\Submission\SubmissionRepository::delete	(	int	$id,
		ResourceStakeholder	$stakeholder
	)

Definition at line 508 of file class.SubmissionRepository.php.

     : void {
        $set = $this->db->queryF(
            "SELECT rid FROM exc_returned " .
            " WHERE returned_id = %s ",
            ["integer"],
            [$id]
        );
        if ($rec = $this->db->fetchAssoc($set)) {
            $rid = (string) ($rec["rid"] ?? "");
            if ($rid !== "") {
                $this->irss->deleteResource(
                    $rid,
                    $stakeholder
                );
            }
            $this->db->manipulateF(
                "DELETE FROM exc_returned WHERE " .
                " returned_id = %s",
                ["integer"],
                [$id]
            );
        }
    }

References $id.

deliverFile()

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

Definition at line 535 of file class.SubmissionRepository.php.

     : void {
        if ($filetitle !== "") {
            $this->irss->renameCurrentRevision($rid, $filetitle);
        }
        $this->irss->deliverFile($rid);
    }

getAllEntriesOfAssignment()

ILIAS\Exercise\Submission\SubmissionRepository::getAllEntriesOfAssignment

(

int

$ass_id

)

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

                                                          : array
    {
        $recs = [];
        $set = $this->db->queryF(
            "SELECT * FROM exc_returned " .
            " WHERE ass_id = %s ",
            ["integer"],
            [$ass_id]
        );
        while ($rec = $this->db->fetchAssoc($set)) {
            $recs[] = $rec;
        }
        return $recs;
    }

References ILIAS\Exercise\Submission\Submission\$ass_id.

getAllSubmissionIdsOfOwner()

ILIAS\Exercise\Submission\SubmissionRepository::getAllSubmissionIdsOfOwner	(	int	$ass_id,
		int	$user_id
	)

Definition at line 206 of file class.SubmissionRepository.php.

                                                                         : array
    {
        $set = $this->db->queryF(
            "SELECT returned_id FROM exc_returned " .
            " WHERE ass_id = %s AND user_id = %s",
            ["integer", "integer"],
            [$ass_id, $user_id]
        );
        $user_ids = [];
        while ($rec = $this->db->fetchAssoc($set)) {
            $user_ids[] = (int) $rec["returned_id"];
        }
        return $user_ids;
    }

References $ass_id, $user_id, and ILIAS\Repository\int().

Here is the call graph for this function:

getById()

ILIAS\Exercise\Submission\SubmissionRepository::getById

(

int

$id

)

Definition at line 183 of file class.SubmissionRepository.php.

     : ?Submission {
        $sql = "SELECT * FROM exc_returned" .
            " WHERE returned_id = " . $this->db->quote($id, "integer");
        $result = $this->db->query($sql);
        if ($row = $this->db->fetchAssoc($result)) {
            return $this->getSubmissionFromRecord($row);
        }
        return null;
    }

getMaxAmountOfSubmittedFiles()

ILIAS\Exercise\Submission\SubmissionRepository::getMaxAmountOfSubmittedFiles	(	int	$obj_id,
		int	$ass_id,
		int	$user_id = 0
	)

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 299 of file class.SubmissionRepository.php.

     : int {
        $db = $this->db;
 
        $and = "";
        if ($user_id > 0) {
            $and = " AND user_id = " . $db->quote($user_id, "integer");
        }
 
        $set = $db->queryF(
            "SELECT MAX(max_num) AS max" .
            " FROM (SELECT COUNT(user_id) AS max_num FROM exc_returned" .
            " WHERE obj_id= %s AND ass_id= %s " . $and . " AND mimetype IS NOT NULL" .
            " GROUP BY user_id) AS COUNTS",
            ["integer", "integer"],
            [$obj_id, $ass_id]
        );
        $row = $db->fetchAssoc($set);
        return (int) $row['max'];
    }

References $user_id.

getStream()

ILIAS\Exercise\Submission\SubmissionRepository::getStream	(	int	$ass_id,
		string	$rid
	)

Definition at line 547 of file class.SubmissionRepository.php.

     : ?FileStream {
        return $this->irss->stream($rid);
    }

getSubmissionFromRecord()

ILIAS\Exercise\Submission\SubmissionRepository::getSubmissionFromRecord ( array  $rec )

protected

Definition at line 384 of file class.SubmissionRepository.php.

                                                          : Submission
    {
        return $this->data->submission(
            (int) $rec["returned_id"],
            (int) $rec["ass_id"],
            (int) $rec["user_id"],
            (int) $rec["team_id"],
            (string) $rec["filetitle"],
            (string) $rec["atext"],
            (string) $rec["rid"],
            (string) $rec["mimetype"],
            (string) $rec["ts"],
            (bool) $rec["late"]
        );
    }

getSubmissions()

ILIAS\Exercise\Submission\SubmissionRepository::getSubmissions ( string  $where, int  $ass_id, bool  $type_uses_uploads, bool  $type_uses_print_versions, ?array  $submit_ids = null, bool  $only_valid = false, ?string  $min_timestamp = null, bool  $print_versions = false  )

protected

Returns

\Generator<Submission>

Definition at line 118 of file class.SubmissionRepository.php.

     : \Generator {
        $sql = "SELECT * FROM exc_returned" .
            " WHERE ass_id = " . $this->db->quote($ass_id, "integer");
        $sql .= " AND " . $where;
 
        if ($submit_ids) {
            $sql .= " AND " . $this->db->in("returned_id", $submit_ids, false, "integer");
        }
 
        if ($min_timestamp) {
            $sql .= " AND ts > " . $this->db->quote($min_timestamp, "timestamp");
        }
 
        $result = $this->db->query($sql);
        $delivered_files = array();
        while ($row = $this->db->fetchAssoc($result)) {
            // blog/portfolio/text submissions
            if ($only_valid &&
                !$row["filename"] &&
                !(trim((string) $row["atext"]))) {
                continue;
            }
 
            //$row["owner_id"] = $row["user_id"];
            $row["timestamp"] = $row["ts"];
            /*
            $row["timestamp14"] = substr($row["ts"], 0, 4) .
                substr($row["ts"], 5, 2) . substr($row["ts"], 8, 2) .
                substr($row["ts"], 11, 2) . substr($row["ts"], 14, 2) .
                substr($row["ts"], 17, 2);*/
 
            $row["rid"] = (string) $row["rid"];
 
            // see 22301, 22719
            if ($row["rid"] !== "" || (!$type_uses_uploads)) {
                $ok = true;
 
                if ($type_uses_print_versions) {
                    $is_print_version = false;
                    if (str_ends_with($row["filetitle"], "print")) {
                        $is_print_version = true;
                    }
                    if (str_ends_with($row["filetitle"], "print.zip")) {
                        $is_print_version = true;
                    }
                    if ($is_print_version != $print_versions) {
                        $ok = false;
                    }
                }
                if ($ok) {
                    yield $this->getSubmissionFromRecord($row);
                }
            }
        }
    }

getSubmissionsOfTeam()

ILIAS\Exercise\Submission\SubmissionRepository::getSubmissionsOfTeam	(	int	$ass_id,
		bool	$type_uses_uploads,
		bool	$type_uses_print_versions,
		int	$team_id,
		?array	$submit_ids = null,
		bool	$only_valid = false,
		?string	$min_timestamp = null,
		bool	$print_versions = false
	)

Returns

\Generator<Submission>

Definition at line 66 of file class.SubmissionRepository.php.

     : \Generator {
        $where = " team_id = " . $this->db->quote($team_id, "integer") . " ";
        yield from $this->getSubmissions(
            $where,
            $ass_id,
            $type_uses_uploads,
            $type_uses_print_versions,
            $submit_ids,
            $only_valid,
            $min_timestamp,
            $print_versions
        );
    }

getSubmissionsOfUsers()

ILIAS\Exercise\Submission\SubmissionRepository::getSubmissionsOfUsers	(	int	$ass_id,
		bool	$type_uses_uploads,
		bool	$type_uses_print_versions,
		array	$user_ids,
		?array	$submit_ids = null,
		bool	$only_valid = false,
		?string	$min_timestamp = null,
		bool	$print_versions = false
	)

Returns

\Generator<Submission>

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

     : \Generator {
        $where = " " . $this->db->in("user_id", $user_ids, false, "integer") . " ";
        yield from $this->getSubmissions(
            $where,
            $ass_id,
            $type_uses_uploads,
            $type_uses_print_versions,
            $submit_ids,
            $only_valid,
            $min_timestamp,
            $print_versions
        );
    }

getUserId()

ILIAS\Exercise\Submission\SubmissionRepository::getUserId

(

int

$submission_id

)

Implements ILIAS\Exercise\Submission\SubmissionRepositoryInterface.

Definition at line 196 of file class.SubmissionRepository.php.

                                                 : int
    {
        $q = "SELECT user_id FROM exc_returned " .
            " WHERE returned_id = " . $this->db->quote($submission_id, "integer");
        $usr_set = $this->db->query($q);
 
        $rec = $this->db->fetchAssoc($usr_set);
        return (int) ($rec["user_id"] ?? 0);
    }

References $q.

getUserSubmissionState()

ILIAS\Exercise\Submission\SubmissionRepository::getUserSubmissionState	(	int	$user_id,
		array	$assignment_ids
	)

Checks if a user has submitted anything for a number of assignments.

This function should be performant, because it is being used for task determination. It assumes, that team db entries only exist for team assignment types and thus does not read the assignment types at all.

Definition at line 247 of file class.SubmissionRepository.php.

                                                                               : array
    {
        $db = $this->db;
 
        $submitted = [];
        foreach ($assignment_ids as $id) {
            $submitted[(int) $id] = false;
        }
 
        $set = $db->queryF(
            "SELECT ass_id FROM exc_returned " .
            " WHERE " . $db->in("ass_id", $assignment_ids, false, "integer") .
            " AND user_id = %s " .
            " AND (filename IS NOT NULL OR atext IS NOT NULL)" .
            " AND ts IS NOT NULL",
            ["integer"],
            [$user_id]
        );
        while ($rec = $db->fetchAssoc($set)) {
            $submitted[(int) $rec["ass_id"]] = true;
        }
 
        $set = $db->queryF(
            "SELECT ret.ass_id FROM exc_returned ret JOIN il_exc_team team " .
            " ON (ret.team_id = team.id AND ret.ass_id = team.ass_id) " .
            " WHERE " . $db->in("ret.ass_id", $assignment_ids, false, "integer") .
            " AND team.user_id = %s " .
            " AND (ret.filename IS NOT NULL OR ret.atext IS NOT NULL)" .
            " AND ret.ts IS NOT NULL",
            ["integer"],
            [$user_id]
        );
        while ($rec = $db->fetchAssoc($set)) {
            $submitted[(int) $rec["ass_id"]] = true;
        }
 
        return $submitted;
    }

References $id, $user_id, and ILIAS\Repository\int().

Here is the call graph for this function:

getUsersWithSubmission()

ILIAS\Exercise\Submission\SubmissionRepository::getUsersWithSubmission

(

int

$ass_id

)

Get all user ids, that have submitted something.

Returns

int[]

Definition at line 327 of file class.SubmissionRepository.php.

                                                       : array
    {
        $db = $this->db;
        $user_ids = [];
        $set = $db->query("SELECT DISTINCT(user_id)" .
            " FROM exc_returned" .
            " WHERE ass_id = " . $db->quote($ass_id, "integer") .
            " AND (filename IS NOT NULL OR atext IS NOT NULL)");
        while ($row = $db->fetchAssoc($set)) {
            $user_ids[] = (int) $row["user_id"];
        }
        return $user_ids;
    }

References $ass_id, and ILIAS\Repository\int().

Here is the call graph for this function:

hasSubmissions()

ILIAS\Exercise\Submission\SubmissionRepository::hasSubmissions

(

int

$assignment_id

)

Implements ILIAS\Exercise\Submission\SubmissionRepositoryInterface.

Definition at line 222 of file class.SubmissionRepository.php.

                                                      : int
    {
        $query = "SELECT * FROM exc_returned " .
            " WHERE ass_id = " . $this->db->quote($assignment_id, "integer") .
            " AND (filename IS NOT NULL OR atext IS NOT NULL)" .
            " AND ts IS NOT NULL";
        $res = $this->db->query($query);
        return $res->numRows();
    }

References $res.

updateLate()

ILIAS\Exercise\Submission\SubmissionRepository::updateLate	(	int	$return_id,
		bool	$late
	)

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

     : void {
        $this->db->manipulate("UPDATE exc_returned" .
            " SET late = " . $this->db->quote((int) $late, "integer") .
            " WHERE returned_id = " . $this->db->quote($return_id, "integer"));
    }

updateWebDirAccessTime()

ILIAS\Exercise\Submission\SubmissionRepository::updateWebDirAccessTime	(	int	$assignment_id,
		int	$member_id
	)

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

                                                                              : void
    {
        $this->db->manipulate("UPDATE exc_returned " .
            " SET web_dir_access_time = " . $this->db->quote(\ilUtil::now(), "timestamp") .
            " WHERE ass_id = " . $this->db->quote($assignment_id, "integer") .
            " AND user_id = " . $this->db->quote($member_id, "integer"));
    }

References ilUtil\now().

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ILIAS\Exercise\Submission\SubmissionRepository::$db

protected

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

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

$log

ILIAS\Exercise\Submission\SubmissionRepository::$log

protected

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

TABLE_NAME

const ILIAS\Exercise\Submission\SubmissionRepository::TABLE_NAME = "exc_returned"

protected

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

---

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

• components/ILIAS/Exercise/Submission/class.SubmissionRepository.php