Inheritance diagram for ilObjExercise:

Collaboration diagram for ilObjExercise:

Public Member Functions
	setId (int $a_id)

	setDate (int $a_hour, int $a_minutes, int $a_day, int $a_month, int $a_year)

	getTimestamp ()

	setTimestamp (int $a_timestamp)

	setInstruction (string $a_instruction)

	getInstruction ()

	setPassMode (string $a_val)

	getPassMode ()

	setPassNr (int $a_val)

	getPassNr ()

	setShowSubmissions (bool $a_val)

	getShowSubmissions ()

	setNrMandatoryRandom (int $a_val)

	getNrMandatoryRandom ()

	checkDate ()

	hasTutorFeedbackText ()

	hasTutorFeedbackMail ()

	hasTutorFeedbackFile ()

	setTutorFeedback (int $a_value)

	saveData ()

	delete ()

	read ()

	update ()

	updateUserStatus (int $a_user_id=0)
	Update exercise status of user. More...

	updateAllUsersStatus ()
	Update status of all users. More...

	exportGradesExcel ()
	Exports grades as excel. More...

	sendFeedbackFileNotification (string $a_feedback_file, array $user_ids, int $a_ass_id, bool $a_is_text_feedback=false)

	isCompletionBySubmissionEnabled ()

	setCompletionBySubmission (bool $bool)

	processExerciseStatus (ilExAssignment $a_ass, array $a_user_ids, bool $a_has_submitted, array $a_valid_submissions=null)

	getCertificateVisibility ()

	setCertificateVisibility (int $a_value)

	saveCertificateVisibility (int $a_value)

Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_lookupFinishedUserExercises (int $a_user_id)
	Get all finished exercises for user. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Data Fields
const	TUTOR_FEEDBACK_MAIL = 1

const	TUTOR_FEEDBACK_TEXT = 2

const	TUTOR_FEEDBACK_FILE = 4

const	PASS_MODE_NR = "nr"

const	PASS_MODE_ALL = "all"

const	PASS_MODE_RANDOM = "random"

ilExerciseMembers	$members_obj = null

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions
	getTutorFeedback ()

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
ilObjUser	$user

ilFileDataMail	$file_obj

int	$timestamp = 0

int	$hour = 0

int	$minutes = 0

int	$day = 0

int	$month = 0

int	$year = 0

string	$instruction = ""

int	$certificate_visibility = 0

int	$tutor_feedback = 7

int	$nr_random_mand = 0

bool	$completion_by_submission = false

Filesystem	$webFilesystem

MandatoryAssignmentsManager	$mandatory_manager

int	$pass_nr = 0

InternalService	$service

string	$pass_mode = self::PASS_MODE_ALL

bool	$show_submissions = false

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

Class ilObjExercise.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de; Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ _lookupFinishedUserExercises()

static ilObjExercise::_lookupFinishedUserExercises ( int $a_user_id )

static

Get all finished exercises for user.

Parameters

int $a_user_id

Returns: bool[] (exercise id => passed)

Definition at line 790 of file class.ilObjExercise.php.

References $DIC, and $ilDB.

                                                                        : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $set = $ilDB->query("SELECT obj_id, status FROM exc_members" .
             " WHERE usr_id = " . $ilDB->quote($a_user_id, "integer") .
             " AND (status = " . $ilDB->quote("passed", "text") .
             " OR status = " . $ilDB->quote("failed", "text") . ")");
 
         $all = array();
         while ($row = $ilDB->fetchAssoc($set)) {
             $all[$row["obj_id"]] = ($row["status"] == "passed");
         }
         return $all;
     }

◆ checkDate()

ilObjExercise::checkDate ( )

Definition at line 186 of file class.ilObjExercise.php.

References ILIAS\Repository\int().

                                : bool
     {
         return  $this->hour == (int) date("H", $this->timestamp) and
             $this->minutes == (int) date("i", $this->timestamp) and
             $this->day == (int) date("d", $this->timestamp) and
             $this->month == (int) date("m", $this->timestamp) and
             $this->year == (int) date("Y", $this->timestamp);
     }

Here is the call graph for this function:

◆ delete()

ilObjExercise::delete ( )

Returns: bool true if all object data were removed; false if only a references were removed

Definition at line 316 of file class.ilObjExercise.php.

References ilObject\$app_event_handler, ilObject\$db, $ilDB, ilExAssignment\getAssignmentDataOfExercise(), ilObject\getId(), ilExcCriteriaCatalogue\getInstancesByParentId(), ilNotification\removeForObject(), and ilNotification\TYPE_EXERCISE_SUBMISSION.

                             : bool
     {
         $ilDB = $this->db;
         $ilAppEventHandler = $this->app_event_handler;
 
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         foreach (ilExAssignment::getAssignmentDataOfExercise($this->getId()) as $item) {
             $ass = new ilExAssignment($item["id"]);
             $ass->delete($this, false);
         }
 
         // members
         $members = new ilExerciseMembers($this);
         $members->delete();
 
         // put here course specific stuff
         $ilDB->manipulate("DELETE FROM exc_data " .
             "WHERE obj_id = " . $ilDB->quote($this->getId(), "integer"));
 
         foreach (\ilExcCriteriaCatalogue::getInstancesByParentId($this->getId()) as $crit_cat) {
             $crit_cat->delete();
         }
 
         // remove all notifications
         ilNotification::removeForObject(ilNotification::TYPE_EXERCISE_SUBMISSION, $this->getId());
 
         $ilAppEventHandler->raise(
             'Modules/Exercise',
             'delete',
             array('obj_id' => $this->getId())
         );
 
         return true;
     }

Here is the call graph for this function:

◆ exportGradesExcel()

ilObjExercise::exportGradesExcel ( )

Exports grades as excel.

Exceptions

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

References $d, $GLOBALS, ilLPMarks\_lookupMark(), ilObjUser\_lookupName(), ilExerciseMembers\_lookupStatus(), ilFileUtils\getASCIIFilename(), ilObject\getId(), ilExAssignment\getInstancesByExercise(), ilObject\getRefId(), ilObject\getTitle(), ILIAS\Repository\lng(), and ilArrayUtil\sortArray().

                                        : void
     {
         $ass_data = ilExAssignment::getInstancesByExercise($this->getId());
 
         $excel = new ilExcel();
         $excel->addSheet($this->lng->txt("exc_status"));
 
         //
         // status
         //
 
         // header row
         $row = $cnt = 1;
         $excel->setCell($row, 0, $this->lng->txt("name"));
         foreach ($ass_data as $ass) {
             $excel->setCell($row, $cnt++, ($cnt / 2) . " - " . $this->lng->txt("exc_tbl_status"));
             $excel->setCell($row, $cnt++, (($cnt - 1) / 2) . " - " . $this->lng->txt("exc_tbl_mark"));
         }
         $excel->setCell($row, $cnt++, $this->lng->txt("exc_total_exc"));
         $excel->setCell($row, $cnt++, $this->lng->txt("exc_mark"));
         $excel->setCell($row++, $cnt, $this->lng->txt("exc_comment_for_learner"));
         $excel->setBold("A1:" . $excel->getColumnCoord($cnt) . "1");
 
         // data rows
         $mem_obj = new ilExerciseMembers($this);
 
         $filtered_members = $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
             'edit_submissions_grades',
             'edit_submissions_grades',
             $this->getRefId(),
             $mem_obj->getMembers()
         );
         $mems = [];
         foreach ((array) $filtered_members as $user_id) {
             $mems[$user_id] = ilObjUser::_lookupName($user_id);
         }
         $mems = ilArrayUtil::sortArray($mems, "lastname", "asc", false, true);
 
         foreach ($mems as $user_id => $d) {
             $col = 0;
 
             // name
             $excel->setCell($row, $col++, $d["lastname"] . ", " . $d["firstname"] . " [" . $d["login"] . "]");
 
             reset($ass_data);
             foreach ($ass_data as $ass) {
                 $status = $ass->getMemberStatus($user_id)->getStatus();
                 $mark = $ass->getMemberStatus($user_id)->getMark();
                 $excel->setCell($row, $col++, $this->lng->txt("exc_" . $status));
                 $excel->setCell($row, $col++, $mark);
             }
 
             // total status
             $status = ilExerciseMembers::_lookupStatus($this->getId(), $user_id);
             $excel->setCell($row, $col++, $this->lng->txt("exc_" . $status));
 
             // #18096
             $marks_obj = new ilLPMarks($this->getId(), $user_id);
             $excel->setCell($row, $col++, $marks_obj->getMark());
             $excel->setCell($row++, $col, $marks_obj->getComment());
         }
 
 
         //
         // mark
         //
 
         $excel->addSheet($this->lng->txt("exc_mark"));
 
         // header row
         $row = $cnt = 1;
         $excel->setCell($row, 0, $this->lng->txt("name"));
         foreach ($ass_data as $ass) {
             $excel->setCell($row, $cnt++, $cnt - 1);
         }
         $excel->setCell($row++, $cnt++, $this->lng->txt("exc_total_exc"));
         $excel->setBold("A1:" . $excel->getColumnCoord($cnt) . "1");
 
         // data rows
         reset($mems);
         foreach ($mems as $user_id => $d) {
             $col = 0;
 
             // name
             $d = ilObjUser::_lookupName($user_id);
             $excel->setCell($row, $col++, $d["lastname"] . ", " . $d["firstname"] . " [" . $d["login"] . "]");
 
             reset($ass_data);
             foreach ($ass_data as $ass) {
                 $excel->setCell($row, $col++, $ass->getMemberStatus($user_id)->getMark());
             }
 
             // total mark
             $excel->setCell($row++, $col, ilLPMarks::_lookupMark($user_id, $this->getId()));
         }
 
         $exc_name = ilFileUtils::getASCIIFilename(preg_replace("/\s/", "_", $this->getTitle()));
         $excel->sendToClient($exc_name);
     }

Here is the call graph for this function:

◆ getCertificateVisibility()

ilObjExercise::getCertificateVisibility ( )

Returns: int visibility settings (0 = always, 1 = only passed, 2 = never)

Definition at line 812 of file class.ilObjExercise.php.

Referenced by saveData().

                                               : int
     {
         return (strlen($this->certificate_visibility) !== 0) ? $this->certificate_visibility : 0;
     }

Here is the caller graph for this function:

◆ getInstruction()

ilObjExercise::getInstruction ( )

Definition at line 129 of file class.ilObjExercise.php.

References $instruction.

Referenced by saveData(), and update().

                                     : string
     {
         return $this->instruction;
     }

Here is the caller graph for this function:

◆ getNrMandatoryRandom()

ilObjExercise::getNrMandatoryRandom ( )

Definition at line 181 of file class.ilObjExercise.php.

References $nr_random_mand.

Referenced by saveData(), and update().

                                           : int
     {
         return $this->nr_random_mand;
     }

Here is the caller graph for this function:

◆ getPassMode()

ilObjExercise::getPassMode ( )

Definition at line 142 of file class.ilObjExercise.php.

References $pass_mode.

Referenced by saveData(), and update().

                                  : string
     {
         return $this->pass_mode;
     }

Here is the caller graph for this function:

◆ getPassNr()

ilObjExercise::getPassNr ( )

Definition at line 155 of file class.ilObjExercise.php.

References $pass_nr.

Referenced by saveData(), and update().

                                : int
     {
         return $this->pass_nr;
     }

Here is the caller graph for this function:

◆ getShowSubmissions()

ilObjExercise::getShowSubmissions ( )

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

References $show_submissions.

Referenced by saveData(), and update().

                                         : bool
     {
         return $this->show_submissions;
     }

Here is the caller graph for this function:

◆ getTimestamp()

ilObjExercise::getTimestamp ( )

Definition at line 112 of file class.ilObjExercise.php.

References $timestamp.

Referenced by saveData(), and update().

                                   : int
     {
         return $this->timestamp;
     }

Here is the caller graph for this function:

◆ getTutorFeedback()

ilObjExercise::getTutorFeedback ( )

protected

Definition at line 210 of file class.ilObjExercise.php.

References $tutor_feedback.

Referenced by saveData(), and update().

                                          : int
     {
         return $this->tutor_feedback;
     }

Here is the caller graph for this function:

◆ hasTutorFeedbackFile()

ilObjExercise::hasTutorFeedbackFile ( )

Definition at line 205 of file class.ilObjExercise.php.

                                           : int
     {
         return $this->tutor_feedback & self::TUTOR_FEEDBACK_FILE;
     }

◆ hasTutorFeedbackMail()

ilObjExercise::hasTutorFeedbackMail ( )

Definition at line 200 of file class.ilObjExercise.php.

                                           : int
     {
         return $this->tutor_feedback & self::TUTOR_FEEDBACK_MAIL;
     }

◆ hasTutorFeedbackText()

ilObjExercise::hasTutorFeedbackText ( )

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

                                           : int
     {
         return $this->tutor_feedback & self::TUTOR_FEEDBACK_TEXT;
     }

◆ isCompletionBySubmissionEnabled()

ilObjExercise::isCompletionBySubmissionEnabled ( )

Definition at line 737 of file class.ilObjExercise.php.

References $completion_by_submission.

Referenced by processExerciseStatus(), saveData(), and update().

                                                      : bool
     {
         return $this->completion_by_submission;
     }

Here is the caller graph for this function:

◆ processExerciseStatus()

ilObjExercise::processExerciseStatus	(	ilExAssignment	$a_ass,
		array	$a_user_ids,
		bool	$a_has_submitted,
		array	$a_valid_submissions = `null`
	)

Exceptions

ilExcUnknownAssignmentTypeException

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

References ilExerciseMembers\_writeReturned(), ilObject\getId(), ilExAssignment\getMemberStatus(), and isCompletionBySubmissionEnabled().

Referenced by ilExAssTypeWikiTeam\handleNewUpload().

      : void {
         foreach ($a_user_ids as $user_id) {
             $member_status = $a_ass->getMemberStatus($user_id);
             $member_status->setReturned($a_has_submitted);
             $member_status->update();
 
             ilExerciseMembers::_writeReturned($this->getId(), $user_id, $a_has_submitted);
         }
 
         // re-evaluate exercise status
         if ($this->isCompletionBySubmissionEnabled()) {
             foreach ($a_user_ids as $user_id) {
                 $status = 'notgraded';
                 if ($a_has_submitted) {
                     if (!is_array($a_valid_submissions) ||
                         $a_valid_submissions[$user_id]) {
                         $status = 'passed';
                     }
                 }
 
                 $member_status = $a_ass->getMemberStatus($user_id);
                 $member_status->setStatus($status);
                 $member_status->update();
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObjExercise::read ( )

Exceptions

ilObjectNotFoundException
ilObjectTypeMismatchException

Definition at line 359 of file class.ilObjExercise.php.

References ilObject\$db, $ilDB, $query, $res, ilObject\getId(), setCertificateVisibility(), setCompletionBySubmission(), setInstruction(), setNrMandatoryRandom(), setPassNr(), setShowSubmissions(), setTimestamp(), and setTutorFeedback().

                           : void
     {
         $ilDB = $this->db;
 
         parent::read();
 
         $query = "SELECT * FROM exc_data " .
             "WHERE obj_id = " . $ilDB->quote($this->getId(), "integer");
 
         $res = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($res)) {
             $this->setInstruction((string) $row->instruction);
             $this->setTimestamp((int) $row->time_stamp);
             $pm = ($row->pass_mode == "")
                 ? "all"
                 : $row->pass_mode;
             $this->setPassMode((string) $pm);
             $this->setShowSubmissions((bool) $row->show_submissions);
             if ($row->pass_mode == "nr") {
                 $this->setPassNr((int) $row->pass_nr);
             }
             $this->setNrMandatoryRandom((int) $row->nr_mandatory_random);
             $this->setCompletionBySubmission($row->compl_by_submission == 1);
             $this->setCertificateVisibility((int) $row->certificate_visibility);
             $this->setTutorFeedback((int) $row->tfeedback);
         }
 
         $this->members_obj = new ilExerciseMembers($this);
     }

Here is the call graph for this function:

◆ saveCertificateVisibility()

ilObjExercise::saveCertificateVisibility ( int $a_value )

Parameters

int $a_value visibility settings (0 = always, 1 = only passed, 2 = never)

Definition at line 828 of file class.ilObjExercise.php.

References ilObject\$db, $ilDB, and ilObject\getId().

      : void {
         $ilDB = $this->db;
 
         $ilDB->manipulateF(
             "UPDATE exc_data SET certificate_visibility = %s WHERE obj_id = %s",
             array('integer', 'integer'),
             array($a_value, $this->getId())
         );
     }

Here is the call graph for this function:

◆ saveData()

ilObjExercise::saveData ( )

Definition at line 220 of file class.ilObjExercise.php.

References ilObject\$db, $ilDB, ilContainer\_getContainerSettings(), ilContainer\_writeContainerSetting(), ilExAssignment\cloneAssignmentsOfExercise(), getCertificateVisibility(), ilObject\getId(), ilOrgUnitGlobalSettings\getInstance(), ilExcCriteriaCatalogue\getInstancesByParentId(), getInstruction(), getNrMandatoryRandom(), getPassMode(), getPassNr(), getShowSubmissions(), getTimestamp(), getTutorFeedback(), isCompletionBySubmissionEnabled(), and ilOrgUnitObjectPositionSetting\setActive().

                               : void
     {
         $ilDB = $this->db;
 
         $ilDB->insert("exc_data", array(
             "obj_id" => array("integer", $this->getId()),
             "instruction" => array("clob", $this->getInstruction()),
             "time_stamp" => array("integer", $this->getTimestamp()),
             "pass_mode" => array("text", $this->getPassMode()),
             "nr_mandatory_random" => array("integer", $this->getNrMandatoryRandom()),
             "pass_nr" => array("text", $this->getPassNr()),
             "show_submissions" => array("integer", (int) $this->getShowSubmissions()),
             'compl_by_submission' => array('integer', (int) $this->isCompletionBySubmissionEnabled()),
             "certificate_visibility" => array("integer", $this->getCertificateVisibility()),
             "tfeedback" => array("integer", $this->getTutorFeedback())
             ));
     }

Here is the call graph for this function:

◆ sendFeedbackFileNotification()

ilObjExercise::sendFeedbackFileNotification	(	string	$a_feedback_file,
		array	$user_ids,
		int	$a_ass_id,
		bool	$a_is_text_feedback = `false`
	)

Definition at line 715 of file class.ilObjExercise.php.

References ilObject\$type, ilObject\getId(), ilObject\getRefId(), ilExerciseMailNotification\TYPE_FEEDBACK_FILE_ADDED, and ilExerciseMailNotification\TYPE_FEEDBACK_TEXT_ADDED.

Referenced by ilExAssignment\saveMultiFeedbackFiles().

      : void {
         $type = $a_is_text_feedback
             ? ilExerciseMailNotification::TYPE_FEEDBACK_TEXT_ADDED
             : ilExerciseMailNotification::TYPE_FEEDBACK_FILE_ADDED;
 
         $not = new ilExerciseMailNotification();
         $not->setType($type);
         $not->setAssignmentId($a_ass_id);
         $not->setObjId($this->getId());
         if ($this->getRefId() > 0) {
             $not->setRefId($this->getRefId());
         }
         $not->setRecipients($user_ids);
         $not->send();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCertificateVisibility()

ilObjExercise::setCertificateVisibility ( int $a_value )

Parameters

int $a_value visibility settings (0 = always, 1 = only passed, 2 = never)

Definition at line 820 of file class.ilObjExercise.php.

Referenced by read().

                                                           : void
     {
         $this->certificate_visibility = $a_value;
     }

Here is the caller graph for this function:

◆ setCompletionBySubmission()

ilObjExercise::setCompletionBySubmission ( bool $bool )

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

Referenced by read().

                                                          : self
     {
         $this->completion_by_submission = $bool;
 
         return $this;
     }

Here is the caller graph for this function:

◆ setDate()

ilObjExercise::setDate	(	int	$a_hour,
		int	$a_minutes,
		int	$a_day,
		int	$a_month,
		int	$a_year
	)

Definition at line 97 of file class.ilObjExercise.php.

      : void {
         $this->hour = $a_hour;
         $this->minutes = $a_minutes;
         $this->day = $a_day;
         $this->month = $a_month;
         $this->year = $a_year;
         $this->timestamp = mktime($this->hour, $this->minutes, 0, $this->month, $this->day, $this->year);
     }

◆ setId()

ilObjExercise::setId ( int $a_id )

Exceptions

ilExcUnknownAssignmentTypeException

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

                                     : void
     {
         parent::setId($a_id);
         // this is needed, since e.g. ilObjectFactory initialises the object with id 0 and later sets the id
         $this->mandatory_manager = $this->service->domain()->assignment()->mandatoryAssignments($this);
     }

◆ setInstruction()

ilObjExercise::setInstruction ( string $a_instruction )

Definition at line 123 of file class.ilObjExercise.php.

Referenced by read().

      : void {
         $this->instruction = $a_instruction;
     }

Here is the caller graph for this function:

◆ setNrMandatoryRandom()

ilObjExercise::setNrMandatoryRandom ( int $a_val )

Parameters

int $a_val number of mandatory assignments in random pass mode

Definition at line 176 of file class.ilObjExercise.php.

Referenced by read().

                                                     : void
     {
         $this->nr_random_mand = $a_val;
     }

Here is the caller graph for this function:

◆ setPassMode()

ilObjExercise::setPassMode ( string $a_val )

Parameters

string $a_val (self::PASS_MODE_NR, self::PASS_MODE_ALL, self::PASS_MODE_RANDOM)

Definition at line 137 of file class.ilObjExercise.php.

                                               : void
     {
         $this->pass_mode = $a_val;
     }

◆ setPassNr()

ilObjExercise::setPassNr ( int $a_val )

Parameters

int $a_val number of assignments that must be passed to pass the exercise

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

Referenced by read().

                                          : void
     {
         $this->pass_nr = $a_val;
     }

Here is the caller graph for this function:

◆ setShowSubmissions()

ilObjExercise::setShowSubmissions ( bool $a_val )

Parameters

bool $a_val whether submissions of learners should be shown to other learners after deadline

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

Referenced by read().

                                                    : void
     {
         $this->show_submissions = $a_val;
     }

Here is the caller graph for this function:

◆ setTimestamp()

ilObjExercise::setTimestamp ( int $a_timestamp )

Definition at line 117 of file class.ilObjExercise.php.

Referenced by read().

      : void {
         $this->timestamp = $a_timestamp;
     }

Here is the caller graph for this function:

◆ setTutorFeedback()

ilObjExercise::setTutorFeedback ( int $a_value )

Definition at line 215 of file class.ilObjExercise.php.

Referenced by read().

                                                   : void
     {
         $this->tutor_feedback = $a_value;
     }

Here is the caller graph for this function:

◆ update()

ilObjExercise::update ( )

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 392 of file class.ilObjExercise.php.

References Vendor\Package\$a, ilObject\$db, $GLOBALS, $ilDB, $ilUser, ilObject\$lng, $mandatory_manager, $user, ilLink\_getLink(), ilDatePresentation\formatDate(), ilExAssignment\getDeadline(), ilExAssignment\getExerciseId(), ilFSStorageExercise\getFiles(), ilExAssignment\getId(), ilObject\getId(), ilObjectFactory\getInstanceByObjId(), ilExAssignment\getInstancesByExercise(), getInstruction(), ilExAssignment\getInstruction(), ilExAssignment\getMemberStatus(), getNrMandatoryRandom(), getPassMode(), getPassNr(), ilObject\getRefId(), getShowSubmissions(), getTimestamp(), ilObject\getTitle(), ilExAssignment\getTitle(), getTutorFeedback(), IL_CAL_UNIX, isCompletionBySubmissionEnabled(), ILIAS\Exercise\Assignment\Mandatory\MandatoryAssignmentsManager\isMandatoryForUser(), ilLanguage\loadLanguageModule(), ilLanguage\txt(), and updateAllUsersStatus().

                             : bool
     {
         $ilDB = $this->db;
 
         parent::update();
 
         $ilDB->update("exc_data", array(
             "instruction" => array("clob", $this->getInstruction()),
             "time_stamp" => array("integer", $this->getTimestamp()),
             "pass_mode" => array("text", $this->getPassMode()),
             "pass_nr" => array("integer", $this->getPassNr()),
             "nr_mandatory_random" => array("integer", $this->getNrMandatoryRandom()),
             "show_submissions" => array("integer", (int) $this->getShowSubmissions()),
             'compl_by_submission' => array('integer', (int) $this->isCompletionBySubmissionEnabled()),
             'tfeedback' => array('integer', $this->getTutorFeedback()),
             ), array(
             "obj_id" => array("integer", $this->getId())
             ));
 
         $this->updateAllUsersStatus();
 
         return true;
     }

Here is the call graph for this function:

◆ updateAllUsersStatus()

ilObjExercise::updateAllUsersStatus ( )

Update status of all users.

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 597 of file class.ilObjExercise.php.

References updateUserStatus().

Referenced by ilExAssignment\delete(), and update().

                                           : void
     {
         if (!isset($this->members_obj)) {
             $this->members_obj = new ilExerciseMembers($this);
         }
 
         $mems = $this->members_obj->getMembers();
         foreach ($mems as $mem) {
             $this->updateUserStatus($mem);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateUserStatus()

ilObjExercise::updateUserStatus ( int $a_user_id = 0 )

Update exercise status of user.

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 576 of file class.ilObjExercise.php.

References $ilUser, $user, ilExerciseMembers\_writeStatus(), and ilObject\getId().

Referenced by ilExAssignmentMemberStatus\postUpdateStatus(), and updateAllUsersStatus().

                                                         : void
     {
         $ilUser = $this->user;
 
         if ($a_user_id == 0) {
             $a_user_id = $ilUser->getId();
         }
 
         $st = $this->determinStatusOfUser($a_user_id);
 
         ilExerciseMembers::_writeStatus(
             $this->getId(),
             $a_user_id,
             $st["overall_status"]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $certificate_visibility

int ilObjExercise::$certificate_visibility = 0

protected

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

◆ $completion_by_submission

bool ilObjExercise::$completion_by_submission = false

protected

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

Referenced by isCompletionBySubmissionEnabled().

◆ $day

int ilObjExercise::$day = 0

protected

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

◆ $file_obj

ilFileDataMail ilObjExercise::$file_obj

protected

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

◆ $hour

int ilObjExercise::$hour = 0

protected

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

◆ $instruction

string ilObjExercise::$instruction = ""

protected

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

Referenced by getInstruction().

◆ $mandatory_manager

MandatoryAssignmentsManager ilObjExercise::$mandatory_manager

protected

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

Referenced by update().

◆ $members_obj

ilExerciseMembers ilObjExercise::$members_obj = null

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

◆ $minutes

int ilObjExercise::$minutes = 0

protected

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

◆ $month

int ilObjExercise::$month = 0

protected

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

◆ $nr_random_mand

int ilObjExercise::$nr_random_mand = 0

protected

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

Referenced by getNrMandatoryRandom().

◆ $pass_mode

string ilObjExercise::$pass_mode = self::PASS_MODE_ALL

protected

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

Referenced by getPassMode().

◆ $pass_nr

int ilObjExercise::$pass_nr = 0

protected

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

Referenced by getPassNr().

◆ $service

InternalService ilObjExercise::$service

protected

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

◆ $show_submissions

bool ilObjExercise::$show_submissions = false

protected

Definition at line 64 of file class.ilObjExercise.php.

Referenced by getShowSubmissions().

◆ $timestamp

int ilObjExercise::$timestamp = 0

protected

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

Referenced by getTimestamp().

◆ $tutor_feedback

int ilObjExercise::$tutor_feedback = 7

protected

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

Referenced by getTutorFeedback().

◆ $user

ilObjUser ilObjExercise::$user

protected

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

Referenced by update(), and updateUserStatus().

◆ $webFilesystem

Filesystem ilObjExercise::$webFilesystem

protected

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

◆ $year

int ilObjExercise::$year = 0

protected

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

◆ PASS_MODE_ALL

const ilObjExercise::PASS_MODE_ALL = "all"

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

Referenced by ilObjExerciseGUI\getService(), and ilObjExerciseGUI\listAssignmentsObject().

◆ PASS_MODE_NR

const ilObjExercise::PASS_MODE_NR = "nr"

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

Referenced by ilObjExerciseGUI\getService(), and ilObjExerciseGUI\listAssignmentsObject().

◆ PASS_MODE_RANDOM

const ilObjExercise::PASS_MODE_RANDOM = "random"

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

Referenced by ilObjExerciseGUI\getService(), ILIAS\Exercise\Assignment\Mandatory\RandomAssignmentsManager\isActivated(), ilObjExerciseGUI\listAssignmentsObject(), and ilObjExerciseGUI\updateCustom().

◆ TUTOR_FEEDBACK_FILE

const ilObjExercise::TUTOR_FEEDBACK_FILE = 4

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

Referenced by ilObjExerciseGUI\getEditFormCustomValues(), and ilObjExerciseGUI\listAssignmentsObject().

◆ TUTOR_FEEDBACK_MAIL

const ilObjExercise::TUTOR_FEEDBACK_MAIL = 1

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

Referenced by ilObjExerciseGUI\getEditFormCustomValues(), and ilObjExerciseGUI\listAssignmentsObject().

◆ TUTOR_FEEDBACK_TEXT

const ilObjExercise::TUTOR_FEEDBACK_TEXT = 2

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

Referenced by ilObjExerciseGUI\getEditFormCustomValues(), and ilObjExerciseGUI\listAssignmentsObject().

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

Modules/Exercise/classes/class.ilObjExercise.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _lookupFinishedUserExercises()

◆ checkDate()

◆ delete()

◆ exportGradesExcel()

◆ getCertificateVisibility()

◆ getInstruction()

◆ getNrMandatoryRandom()

◆ getPassMode()

◆ getPassNr()

◆ getShowSubmissions()

◆ getTimestamp()

◆ getTutorFeedback()

◆ hasTutorFeedbackFile()

◆ hasTutorFeedbackMail()

◆ hasTutorFeedbackText()

◆ isCompletionBySubmissionEnabled()

◆ processExerciseStatus()

◆ read()

◆ saveCertificateVisibility()

◆ saveData()

◆ sendFeedbackFileNotification()

◆ setCertificateVisibility()

◆ setCompletionBySubmission()

◆ setDate()

◆ setId()

◆ setInstruction()

◆ setNrMandatoryRandom()

◆ setPassMode()

◆ setPassNr()

◆ setShowSubmissions()

◆ setTimestamp()

◆ setTutorFeedback()

◆ update()

◆ updateAllUsersStatus()

◆ updateUserStatus()

Field Documentation

◆ $certificate_visibility

◆ $completion_by_submission

◆ $day

◆ $file_obj

◆ $hour

◆ $instruction

◆ $mandatory_manager

◆ $members_obj

◆ $minutes

◆ $month

◆ $nr_random_mand

◆ $pass_mode

◆ $pass_nr

◆ $service

◆ $show_submissions

◆ $timestamp

◆ $tutor_feedback

◆ $user

◆ $webFilesystem

◆ $year

◆ PASS_MODE_ALL

◆ PASS_MODE_NR

◆ PASS_MODE_RANDOM

◆ TUTOR_FEEDBACK_FILE

◆ TUTOR_FEEDBACK_MAIL

◆ TUTOR_FEEDBACK_TEXT