Inheritance diagram for ilObjExercise:

Collaboration diagram for ilObjExercise:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...

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

	getTimestamp ()

	setTimestamp ($a_timestamp)

	setInstruction ($a_instruction)

	getInstruction ()

	setPassMode ($a_val)
	Set pass mode (all \| nr) More...

	getPassMode ()
	Get pass mode (all \| nr) More...

	setPassNr ($a_val)
	Set number of assignments that must be passed to pass the exercise. More...

	getPassNr ()
	Get number of assignments that must be passed to pass the exercise. More...

	setShowSubmissions ($a_val)
	Set whether submissions of learners should be shown to other learners after deadline. More...

	getShowSubmissions ()
	Get whether submissions of learners should be shown to other learners after deadline. More...

	checkDate ()

	hasTutorFeedbackText ()

	hasTutorFeedbackMail ()

	hasTutorFeedbackFile ()

	setTutorFeedback ($a_value)

	saveData ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone exercise (no member data) More...

	delete ()
	delete course and all related data More...

	read ()

	update ()

	sendAssignment (ilExAssignment $a_ass, $a_members)
	send exercise per mail to members More...

	determinStatusOfUser ($a_user_id=0)
	Determine status of user. More...

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

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

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

	sendFeedbackFileNotification ($a_feedback_file, $a_user_id, $a_ass_id, $a_is_text_feedback=false)
	Send feedback file notification to user. More...

	isCompletionBySubmissionEnabled ()
	Checks whether completion by submission is enabled or not. More...

	setCompletionBySubmission ($bool)
	Enabled/Disable completion by submission. More...

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

	getCertificateVisibility ()
	Returns the visibility settings of the certificate. More...

	setCertificateVisibility ($a_value)
	Sets the visibility settings of the certificate. More...

	saveCertificateVisibility ($a_value)
	Saves the visibility settings of the certificate. More...

	hasUserCertificate ($a_user_id)
	Check if given user has certificate to show/download. More...

	hasAddToDesktop ()
	Add to desktop after hand-in. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

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

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

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

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

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

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

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

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

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

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

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

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

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

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

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

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
	$file_obj

	$members_obj

	$files

	$timestamp

	$hour

	$minutes

	$day

	$month

	$year

	$instruction

	$certificate_visibility

	$tutor_feedback = 7

const	TUTOR_FEEDBACK_MAIL = 1

const	TUTOR_FEEDBACK_TEXT = 2

const	TUTOR_FEEDBACK_FILE = 4

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Protected Member Functions
	getTutorFeedback ()

Protected Attributes
	$user

	$completion_by_submission = false

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjExercise::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

References $DIC, setPassMode(), and user().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->app_event_handler = $DIC["ilAppEventHandler"];
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->setPassMode("all");
         $this->type = "exc";
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _lookupFinishedUserExercises()

static ilObjExercise::_lookupFinishedUserExercises ( $a_user_id )

static

Get all exercises for user.

Parameters

<type> $a_user_id

Returns: array (exercise id => passed)

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

References $DIC, $ilDB, $row, and array.

Referenced by ilExerciseVerificationTableGUI\getItems().

     {
         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;
     }

Here is the caller graph for this function:

◆ checkDate()

ilObjExercise::checkDate ( )

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

References date.

     {
         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);
     }

◆ cloneObject()

ilObjExercise::cloneObject	(	$a_target_id,
		$a_copy_id = `0`,
		$a_omit_tree = `false`
	)

Clone exercise (no member data)

public

Parameters

int	target ref_id
int	copy id

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

References ilObject\$db, $ilDB, array, ilExAssignment\cloneAssignmentsOfExercise(), getCertificateVisibility(), ilObject\getId(), ilExcCriteriaCatalogue\getInstancesByParentId(), getInstruction(), getPassMode(), getPassNr(), getShowSubmissions(), getTimestamp(), getTutorFeedback(), and isCompletionBySubmissionEnabled().

     {
         $ilDB = $this->db;
         
         // Copy settings
         $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
         $new_obj->setInstruction($this->getInstruction());
         $new_obj->setTimestamp($this->getTimestamp());
         $new_obj->setPassMode($this->getPassMode());
         $new_obj->saveData();
         $new_obj->setPassNr($this->getPassNr());
         $new_obj->setShowSubmissions($this->getShowSubmissions());
         $new_obj->setCompletionBySubmission($this->isCompletionBySubmissionEnabled());
         $new_obj->setTutorFeedback($this->getTutorFeedback());
         $new_obj->setCertificateVisibility($this->getCertificateVisibility());
         $new_obj->update();
 
         $new_obj->saveCertificateVisibility($this->getCertificateVisibility());
         
         // Copy criteria catalogues
         $crit_cat_map = array();
         include_once("./Modules/Exercise/classes/class.ilExcCriteriaCatalogue.php");
         foreach (ilExcCriteriaCatalogue::getInstancesByParentId($this->getId()) as $crit_cat) {
             $new_id = $crit_cat->cloneObject($new_obj->getId());
             $crit_cat_map[$crit_cat->getId()] = $new_id;
         }
             
         // Copy assignments
         include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
         ilExAssignment::cloneAssignmentsOfExercise($this->getId(), $new_obj->getId(), $crit_cat_map);
         
         // Copy learning progress settings
         include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
         $obj_settings = new ilLPObjSettings($this->getId());
         $obj_settings->cloneSettings($new_obj->getId());
         unset($obj_settings);
         
         // #18945
         include_once "./Services/Certificate/classes/class.ilCertificate.php";
         include_once "./Modules/Exercise/classes/class.ilExerciseCertificateAdapter.php";
         $cert = new ilCertificate(new ilExerciseCertificateAdapter($this));
         $newcert = new ilCertificate(new ilExerciseCertificateAdapter($new_obj));
         $cert->cloneCertificate($newcert);
             
         return $new_obj;
     }

Here is the call graph for this function:

◆ delete()

ilObjExercise::delete ( )

delete course and all related data

public

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

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

References ilObject\$app_event_handler, ilObject\$db, $ilDB, array, ilExcCriteriaCatalogue\deleteByParent(), ilObject\getId(), ilNotification\removeForObject(), and ilNotification\TYPE_EXERCISE_SUBMISSION.

     {
         $ilDB = $this->db;
         $ilAppEventHandler = $this->app_event_handler;
 
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
         // put here course specific stuff
         $ilDB->manipulate("DELETE FROM exc_data " .
             "WHERE obj_id = " . $ilDB->quote($this->getId(), "integer"));
 
         include_once "Modules/Exercise/classes/class.ilExcCriteriaCatalogue.php";
         ilExcCriteriaCatalogue::deleteByParent($this->getId());
 
         // remove all notifications
         include_once "./Services/Notification/classes/class.ilNotification.php";
         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:

◆ determinStatusOfUser()

ilObjExercise::determinStatusOfUser ( $a_user_id = 0 )

Determine status of user.

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

References $ilUser, $ret, $user, array, ilObject\getId(), ilExAssignment\getInstancesByExercise(), getPassMode(), and getPassNr().

Referenced by updateUserStatus().

     {
         $ilUser = $this->user;
 
         if ($a_user_id == 0) {
             $a_user_id = $ilUser->getId();
         }
         
         include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
         $ass = ilExAssignment::getInstancesByExercise($this->getId());
         
         $passed_all_mandatory = true;
         $failed_a_mandatory = false;
         $cnt_passed = 0;
         $cnt_notgraded = 0;
         $passed_at_least_one = false;
         
         foreach ($ass as $a) {
             $stat = $a->getMemberStatus($a_user_id)->getStatus();
             if ($a->getMandatory() && ($stat == "failed" || $stat == "notgraded")) {
                 $passed_all_mandatory = false;
             }
             if ($a->getMandatory() && ($stat == "failed")) {
                 $failed_a_mandatory = true;
             }
             if ($stat == "passed") {
                 $cnt_passed++;
             }
             if ($stat == "notgraded") {
                 $cnt_notgraded++;
             }
         }
         
         if (count($ass) == 0) {
             $passed_all_mandatory = false;
         }
         
         if ($this->getPassMode() != "nr") {
             //echo "5";
             $overall_stat = "notgraded";
             if ($failed_a_mandatory) {
                 //echo "6";
                 $overall_stat = "failed";
             } elseif ($passed_all_mandatory && $cnt_passed > 0) {
                 //echo "7";
                 $overall_stat = "passed";
             }
         } else {
             //echo "8";
             $min_nr = $this->getPassNr();
             $overall_stat = "notgraded";
             //echo "*".$cnt_passed."*".$cnt_notgraded."*".$min_nr."*";
             if ($failed_a_mandatory || ($cnt_passed + $cnt_notgraded < $min_nr)) {
                 //echo "9";
                 $overall_stat = "failed";
             } elseif ($passed_all_mandatory && $cnt_passed >= $min_nr) {
                 //echo "A";
                 $overall_stat = "passed";
             }
         }
         
         $ret =  array(
             "overall_status" => $overall_stat,
             "failed_a_mandatory" => $failed_a_mandatory);
         //echo "<br>p:".$cnt_passed.":ng:".$cnt_notgraded;
         //var_dump($ret);
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportGradesExcel()

ilObjExercise::exportGradesExcel ( )

Exports grades as excel.

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

References $d, $GLOBALS, $row, ilLPMarks\_lookupMark(), ilObjUser\_lookupName(), ilExerciseMembers\_lookupStatus(), array, ilUtil\getASCIIFilename(), ilObject\getId(), ilExAssignment\getInstancesByExercise(), ilObject\getRefId(), ilObject\getTitle(), and ilUtil\sortArray().

     {
         include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
         $ass_data = ilExAssignment::getInstancesByExercise($this->getId());
         
         include_once "./Services/Excel/classes/class.ilExcel.php";
         $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-1);
         }
         $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(
             'etit_submissions_grades',
             'edit_submissions_grades',
             $this->getRefId(),
             (array) $mem_obj->getMembers()
         );
         
         foreach ((array) $filtered_members as $user_id) {
             $mems[$user_id] = ilObjUser::_lookupName($user_id);
         }
         $mems = ilUtil::sortArray($mems, "lastname", "asc", false, true);
         
         include_once 'Services/Tracking/classes/class.ilLPMarks.php';
         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();
                 $excel->setCell($row, $col++, $this->lng->txt("exc_" . $status));
             }
             
             // 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 = ilUtil::getASCIIFilename(preg_replace("/\s/", "_", $this->getTitle()));
         $excel->sendToClient($exc_name);
     }

Here is the call graph for this function:

◆ getCertificateVisibility()

ilObjExercise::getCertificateVisibility ( )

Returns the visibility settings of the certificate.

Returns: integer The value for the visibility settings (0 = always, 1 = only passed, 2 = never) public

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

Referenced by cloneObject(), hasUserCertificate(), and saveData().

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

Here is the caller graph for this function:

◆ getInstruction()

ilObjExercise::getInstruction ( )

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

References $instruction.

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

     {
         return $this->instruction;
     }

Here is the caller graph for this function:

◆ getPassMode()

ilObjExercise::getPassMode ( )

Get pass mode (all | nr)

Returns: string pass mode

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

Referenced by cloneObject(), determinStatusOfUser(), saveData(), and update().

     {
         return $this->pass_mode;
     }

Here is the caller graph for this function:

◆ getPassNr()

ilObjExercise::getPassNr ( )

Get number of assignments that must be passed to pass the exercise.

Returns: integer pass nr

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

Referenced by cloneObject(), determinStatusOfUser(), saveData(), and update().

     {
         return $this->pass_nr;
     }

Here is the caller graph for this function:

◆ getShowSubmissions()

ilObjExercise::getShowSubmissions ( )

Get whether submissions of learners should be shown to other learners after deadline.

Returns: integer show submissions

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

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

     {
         return $this->show_submissions;
     }

Here is the caller graph for this function:

◆ getTimestamp()

ilObjExercise::getTimestamp ( )

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

References $timestamp.

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

     {
         return $this->timestamp;
     }

Here is the caller graph for this function:

◆ getTutorFeedback()

ilObjExercise::getTutorFeedback ( )

protected

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

References $tutor_feedback.

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

     {
         return $this->tutor_feedback;
     }

Here is the caller graph for this function:

◆ hasAddToDesktop()

ilObjExercise::hasAddToDesktop ( )

Add to desktop after hand-in.

Returns: bool

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

     {
         $exc_set = new ilSetting("excs");
         return (bool) $exc_set->get("add_to_pd", true);
     }

◆ hasTutorFeedbackFile()

ilObjExercise::hasTutorFeedbackFile ( )

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

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

◆ hasTutorFeedbackMail()

ilObjExercise::hasTutorFeedbackMail ( )

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

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

◆ hasTutorFeedbackText()

ilObjExercise::hasTutorFeedbackText ( )

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

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

◆ hasUserCertificate()

ilObjExercise::hasUserCertificate ( $a_user_id )

Check if given user has certificate to show/download.

Parameters

int $a_user_id

Returns: bool

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

References ilExerciseMembers\_lookupStatus(), getCertificateVisibility(), ilObject\getId(), ilCertificate\isActive(), and ilCertificate\isObjectActive().

     {
         // show certificate?
         include_once "Services/Certificate/classes/class.ilCertificate.php";
         if (ilCertificate::isActive() && ilCertificate::isObjectActive($this->getId())) {
             $certificate_visible = $this->getCertificateVisibility();
             // if not never
             if ($certificate_visible != 2) {
                 // if passed only
                 include_once 'Modules/Exercise/classes/class.ilExerciseMembers.php';
                 $status = ilExerciseMembers::_lookupStatus($this->getId(), $a_user_id);
                 if ($certificate_visible == 1 && $status == "passed") {
                     return true;
                 }
                 // always (excluding notgraded)
                 elseif ($certificate_visible == 0 && $status != "notgraded") {
                     return true;
                 }
             }
         }
         return false;
     }

Here is the call graph for this function:

◆ isCompletionBySubmissionEnabled()

ilObjExercise::isCompletionBySubmissionEnabled ( )

Checks whether completion by submission is enabled or not.

Returns: boolean public

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

References $completion_by_submission.

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

     {
         return $this->completion_by_submission;
     }

Here is the caller graph for this function:

◆ processExerciseStatus()

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

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

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

Referenced by ilExPeerReviewGUI\handlePeerReviewChange().

     {
         $a_has_submitted = (bool) $a_has_submitted;
         
         include_once("./Modules/Exercise/classes/class.ilExerciseMembers.php");
         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 ( )

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

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

     {
         $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($row->instruction);
             $this->setTimestamp($row->time_stamp);
             $pm = ($row->pass_mode == "")
                 ? "all"
                 : $row->pass_mode;
             $this->setPassMode($pm);
             $this->setShowSubmissions($row->show_submissions);
             if ($row->pass_mode == "nr") {
                 $this->setPassNr($row->pass_nr);
             }
             $this->setCompletionBySubmission($row->compl_by_submission == 1 ? true : false);
             $this->setCertificateVisibility($row->certificate_visibility);
             $this->setTutorFeedback($row->tfeedback);
         }
         
         $this->members_obj = new ilExerciseMembers($this);
 
         return true;
     }

Here is the call graph for this function:

◆ saveCertificateVisibility()

ilObjExercise::saveCertificateVisibility ( $a_value )

Saves the visibility settings of the certificate.

Parameters

integer $a_value The value for the visibility settings (0 = always, 1 = only passed, 2 = never) private

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

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

     {
         $ilDB = $this->db;
 
         $affectedRows = $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 202 of file class.ilObjExercise.php.

References ilObject\$db, $ilDB, array, getCertificateVisibility(), ilObject\getId(), getInstruction(), getPassMode(), getPassNr(), getShowSubmissions(), getTimestamp(), getTutorFeedback(), and isCompletionBySubmissionEnabled().

     {
         $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()),
             "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", (int) $this->getCertificateVisibility()),
             "tfeedback" => array("integer", (int) $this->getTutorFeedback())
             ));
         return true;
     }

Here is the call graph for this function:

◆ sendAssignment()

ilObjExercise::sendAssignment	(	ilExAssignment	$a_ass,
			$a_members
	)

send exercise per mail to members

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

References $file, $files, $GLOBALS, $ilUser, ilObject\$lng, $message, $user, ilLink\_getLink(), array, ilDatePresentation\formatDate(), ilExAssignment\getDeadline(), ilExAssignment\getExerciseId(), ilExAssignment\getId(), ilObject\getId(), ilObjectFactory\getInstanceByObjId(), ilExAssignment\getInstruction(), ilExAssignment\getMemberStatus(), ilObject\getRefId(), ilExAssignment\getTitle(), ilObject\getTitle(), and IL_CAL_UNIX.

     {
         $lng = $this->lng;
         $ilUser = $this->user;
         
         $lng->loadLanguageModule("exc");
         
         // subject
         $subject = $a_ass->getTitle()
             ? $this->getTitle() . ": " . $a_ass->getTitle()
             : $this->getTitle();
         
         
         // body
         
         $body = $a_ass->getInstruction();
         $body .= "\n\n";
         
         $body .= $lng->txt("exc_edit_until") . ": ";
         $body .= (!$a_ass->getDeadline())
           ? $lng->txt("exc_no_deadline_specified")
           : ilDatePresentation::formatDate(new ilDateTime($a_ass->getDeadline(), IL_CAL_UNIX));
         $body .= "\n\n";
         
         include_once "Services/Link/classes/class.ilLink.php";
         $body .= ilLink::_getLink($this->getRefId(), "exc");
         
 
         // files
         $file_names = array();
         include_once("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
         $storage = new ilFSStorageExercise($a_ass->getExerciseId(), $a_ass->getId());
         $files = $storage->getFiles();
         if (count($files)) {
             include_once "./Services/Mail/classes/class.ilFileDataMail.php";
             $mfile_obj = new ilFileDataMail($GLOBALS['DIC']['ilUser']->getId());
             foreach ($files as $file) {
                 $mfile_obj->copyAttachmentFile($file["fullpath"], $file["name"]);
                 $file_names[] = $file["name"];
             }
         }
         
         // recipients
         $recipients = array();
         foreach ($a_members as $member_id) {
             $tmp_obj = ilObjectFactory::getInstanceByObjId($member_id);
             $recipients[] = $tmp_obj->getLogin();
             unset($tmp_obj);
         }
         $recipients = implode(",", $recipients);
     
         // send mail
         include_once "Services/Mail/classes/class.ilMail.php";
         $tmp_mail_obj = new ilMail($ilUser->getId());
         $message = $tmp_mail_obj->sendMail(
             $recipients,
             "",
             "",
             $subject,
             $body,
             $file_names,
             array("normal")
         );
         unset($tmp_mail_obj);
 
         // remove tmp files
         if (sizeof($file_names)) {
             $mfile_obj->unlinkFiles($file_names);
             unset($mfile_obj);
         }
 
         // set recipients mail status
         foreach ($a_members as $member_id) {
             $member_status = $a_ass->getMemberStatus($member_id);
             $member_status->setSent(true);
             $member_status->update();
         }
 
         return true;
     }

Here is the call graph for this function:

◆ sendFeedbackFileNotification()

ilObjExercise::sendFeedbackFileNotification	(	$a_feedback_file,
		$a_user_id,
		$a_ass_id,
		$a_is_text_feedback = `false`
	)

Send feedback file notification to user.

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

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

Referenced by ilExAssignment\saveMultiFeedbackFiles().

     {
         $user_ids = $a_user_id;
         if (!is_array($user_ids)) {
             $user_ids = array($user_ids);
         }
         
         include_once("./Modules/Exercise/classes/class.ilExerciseMailNotification.php");
         
         $type = (bool) $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 ( $a_value )

Sets the visibility settings of the certificate.

Parameters

integer $a_value The value for the visibility settings (0 = always, 1 = only passed, 2 = never) public

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

Referenced by read().

     {
         $this->certificate_visibility = $a_value;
     }

Here is the caller graph for this function:

◆ setCompletionBySubmission()

ilObjExercise::setCompletionBySubmission ( $bool )

Enabled/Disable completion by submission.

Parameters

boolean

Returns: ilObjExercise public

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

Referenced by read().

     {
         $this->completion_by_submission = (bool) $bool;
         
         return $this;
     }

Here is the caller graph for this function:

◆ setDate()

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

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

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

◆ setInstruction()

ilObjExercise::setInstruction ( $a_instruction )

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

Referenced by read().

     {
         $this->instruction = $a_instruction;
     }

Here is the caller graph for this function:

◆ setPassMode()

ilObjExercise::setPassMode ( $a_val )

Set pass mode (all | nr)

Parameters

string pass mode

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

Referenced by __construct().

     {
         $this->pass_mode = $a_val;
     }

Here is the caller graph for this function:

◆ setPassNr()

ilObjExercise::setPassNr ( $a_val )

Set number of assignments that must be passed to pass the exercise.

Parameters

integer pass nr

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

Referenced by read().

     {
         $this->pass_nr = $a_val;
     }

Here is the caller graph for this function:

◆ setShowSubmissions()

ilObjExercise::setShowSubmissions ( $a_val )

Set whether submissions of learners should be shown to other learners after deadline.

Parameters

boolean show submissions

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

Referenced by read().

     {
         $this->show_submissions = $a_val;
     }

Here is the caller graph for this function:

◆ setTimestamp()

ilObjExercise::setTimestamp ( $a_timestamp )

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

Referenced by read().

     {
         $this->timestamp = $a_timestamp;
     }

Here is the caller graph for this function:

◆ setTutorFeedback()

ilObjExercise::setTutorFeedback ( $a_value )

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

Referenced by read().

     {
         $this->tutor_feedback = $a_value;
     }

Here is the caller graph for this function:

◆ update()

ilObjExercise::update ( )

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

References ilObject\$db, $ilDB, array, ilObject\getId(), getInstruction(), getPassMode(), getPassNr(), getShowSubmissions(), getTimestamp(), getTutorFeedback(), isCompletionBySubmissionEnabled(), League\Flysystem\Adapter\Polyfill\update(), and updateAllUsersStatus().

     {
         $ilDB = $this->db;
 
         parent::update();
 
         if ($this->getPassMode() == "all") {
             $pass_nr = null;
         } else {
             $pass_nr = $this->getPassNr();
         }
 
         $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()),
             "show_submissions" => array("integer", (int) $this->getShowSubmissions()),
             'compl_by_submission' => array('integer', (int) $this->isCompletionBySubmissionEnabled()),
             'tfeedback' => array('integer', (int) $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.

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

References updateUserStatus().

Referenced by update().

     {
         if (!is_object($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 ( $a_user_id = 0 )

Update exercise status of user.

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

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

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

     {
         $ilUser = $this->user;
         
         if ($a_user_id == 0) {
             $a_user_id = $ilUser->getId();
         }
 
         $st = $this->determinStatusOfUser($a_user_id);
 
         include_once("./Modules/Exercise/classes/class.ilExerciseMembers.php");
         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

ilObjExercise::$certificate_visibility

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

◆ $completion_by_submission

ilObjExercise::$completion_by_submission = false

protected

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

Referenced by isCompletionBySubmissionEnabled().

◆ $day

ilObjExercise::$day

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

◆ $file_obj

ilObjExercise::$file_obj

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

◆ $files

ilObjExercise::$files

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

Referenced by sendAssignment().

◆ $hour

ilObjExercise::$hour

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

◆ $instruction

ilObjExercise::$instruction

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

Referenced by getInstruction().

◆ $members_obj

ilObjExercise::$members_obj

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

◆ $minutes

ilObjExercise::$minutes

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

◆ $month

ilObjExercise::$month

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

◆ $timestamp

ilObjExercise::$timestamp

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

Referenced by getTimestamp().

◆ $tutor_feedback

ilObjExercise::$tutor_feedback = 7

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

Referenced by getTutorFeedback().

◆ $user

ilObjExercise::$user

protected

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

Referenced by determinStatusOfUser(), sendAssignment(), and updateUserStatus().

◆ $year

ilObjExercise::$year

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

◆ TUTOR_FEEDBACK_FILE

const ilObjExercise::TUTOR_FEEDBACK_FILE = 4

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

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

◆ TUTOR_FEEDBACK_MAIL

const ilObjExercise::TUTOR_FEEDBACK_MAIL = 1

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

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

◆ TUTOR_FEEDBACK_TEXT

const ilObjExercise::TUTOR_FEEDBACK_TEXT = 2

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

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

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

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _lookupFinishedUserExercises()

◆ checkDate()

◆ cloneObject()

◆ delete()

◆ determinStatusOfUser()

◆ exportGradesExcel()

◆ getCertificateVisibility()

◆ getInstruction()

◆ getPassMode()

◆ getPassNr()

◆ getShowSubmissions()

◆ getTimestamp()

◆ getTutorFeedback()

◆ hasAddToDesktop()

◆ hasTutorFeedbackFile()

◆ hasTutorFeedbackMail()

◆ hasTutorFeedbackText()

◆ hasUserCertificate()

◆ isCompletionBySubmissionEnabled()

◆ processExerciseStatus()

◆ read()

◆ saveCertificateVisibility()

◆ saveData()

◆ sendAssignment()

◆ sendFeedbackFileNotification()

◆ setCertificateVisibility()

◆ setCompletionBySubmission()

◆ setDate()

◆ setInstruction()

◆ setPassMode()

◆ setPassNr()

◆ setShowSubmissions()

◆ setTimestamp()

◆ setTutorFeedback()

◆ update()

◆ updateAllUsersStatus()

◆ updateUserStatus()

Field Documentation

◆ $certificate_visibility

◆ $completion_by_submission

◆ $day

◆ $file_obj

◆ $files

◆ $hour

◆ $instruction

◆ $members_obj

◆ $minutes

◆ $month

◆ $timestamp

◆ $tutor_feedback

◆ $user

◆ $year

◆ TUTOR_FEEDBACK_FILE

◆ TUTOR_FEEDBACK_MAIL

◆ TUTOR_FEEDBACK_TEXT