Inheritance diagram for ilObjExercise:

Collaboration diagram for ilObjExercise:

Public Member Functions
	ilObjExercise ($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 ()

	saveData ()

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

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

	notify ($a_event, $a_ref_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event happend, each object may decide how it reacts. 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
	ilObject ($a_id=0, $a_reference=true)
	Constructor public. More...

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

	read ($a_force_db=false)
	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 ()

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

	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...

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...

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

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

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

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

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

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

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

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

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

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

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

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

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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...

	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 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...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

	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...

	_lookupCreationDate ($a_id)
	Lookup creation date. 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	_getAllReferences ($a_id)
	get all reference ids of object More...

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

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

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

static	_lookupObjId ($a_id)

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

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

static	_lookupObjectId ($a_ref_id)
	lookup object id 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	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

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

const	DESC_LENGTH = 128

	$ilias

	$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

	$obj_data_record
	object_data record More...

Protected Attributes
	$completion_by_submission = 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

Version: $Id$

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

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 797 of file class.ilObjExercise.php.

References $ilDB, and $row.

Referenced by ilExerciseVerificationTableGUI\getItems().

         {
                 global $ilDB;
 
                 $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 151 of file class.ilObjExercise.php.

         {
                 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`
	)

Clone exercise (no member data)

public

Parameters

int	target ref_id
int	copy id

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

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

         {
                 global $ilDB;
                 
                 // Copy settings
                 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                 $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->update();
                 
                 // 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);
                         
                 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 236 of file class.ilObjExercise.php.

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

         {
                 global $ilDB, $ilAppEventHandler;
 
                 // 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"));
 
                 //$this->ilias->db->query($query);
 
                 //$this->file_obj->delete();
                 //$this->members_obj->delete();
                 
                 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 450 of file class.ilObjExercise.php.

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

Referenced by updateUserStatus().

         {
                 global $ilUser;
 
                 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";
                         }
                         else if ($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";
                         }
                         else if ($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 574 of file class.ilObjExercise.php.

References $d, $data, ilExcelUtils\_convert_text(), ilLPMarks\_lookupMark(), ilObjUser\_lookupName(), ilExerciseMembers\_lookupStatus(), ilUtil\deliverFile(), ilUtil\getASCIIFilename(), ilObject\getId(), ilExAssignment\getInstancesByExercise(), ilObject\getTitle(), ilUtil\ilTempnam(), and ilUtil\sortArray().

         {
                 include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
                 $ass_data = ilExAssignment::getInstancesByExercise($this->getId());
                 
                 include_once "./Services/Excel/classes/class.ilExcelWriterAdapter.php";
                 $excelfile = ilUtil::ilTempnam();
                 $adapter = new ilExcelWriterAdapter($excelfile, FALSE);
                 $workbook = $adapter->getWorkbook();
                 $workbook->setVersion(8); // Use Excel97/2000 Format
                 include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                 
                 //
                 // status
                 //
                 $mainworksheet = $workbook->addWorksheet();
                 
                 // header row
                 $mainworksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("name")));
                 $cnt = 1;
                 foreach ($ass_data as $ass)
                 {
                         $mainworksheet->writeString(0, $cnt, $cnt);
                         $cnt++;
                 }
                 $mainworksheet->writeString(0, $cnt++, ilExcelUtils::_convert_text($this->lng->txt("exc_total_exc")));
                 $mainworksheet->writeString(0, $cnt++, ilExcelUtils::_convert_text($this->lng->txt("exc_mark")));
                 $mainworksheet->writeString(0, $cnt, ilExcelUtils::_convert_text($this->lng->txt("exc_comment_for_learner")));
                 
                 // data rows
                 $this->mem_obj = new ilExerciseMembers($this);
                 $getmems = $this->mem_obj->getMembers();
                 $mems = array();
                 foreach ($getmems 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';
                 
                 $data = array();
                 $row_cnt = 1;
                 foreach ($mems as $user_id => $d)
                 {
                         $col_cnt = 1;
 
                         // name
                         $mainworksheet->writeString($row_cnt, 0,
                                 ilExcelUtils::_convert_text($d["lastname"].", ".$d["firstname"]." [".$d["login"]."]"));
 
                         reset($ass_data);
 
                         foreach ($ass_data as $ass)
                         {
                                 $status = $ass->getMemberStatus($user_id)->getStatus();
                                 $mainworksheet->writeString($row_cnt, $col_cnt, ilExcelUtils::_convert_text($this->lng->txt("exc_".$status)));
                                 $col_cnt++;
                         }
                         
                         // total status
                         $status = ilExerciseMembers::_lookupStatus($this->getId(), $user_id);
                         $mainworksheet->writeString($row_cnt, $col_cnt++, ilExcelUtils::_convert_text($this->lng->txt("exc_".$status)));
 
                         // #18096
                         $marks_obj = new ilLPMarks($this->getId(), $user_id);
                         $mainworksheet->writeString($row_cnt, $col_cnt++, ilExcelUtils::_convert_text($marks_obj->getMark()));
                         $mainworksheet->writeString($row_cnt, $col_cnt, ilExcelUtils::_convert_text($marks_obj->getComment()));
                         
                         $row_cnt++;
                 }
                 
                 //
                 // mark
                 //
                 $worksheet2 = $workbook->addWorksheet();
                 
                 // header row
                 $worksheet2->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("name")));
                 $cnt = 1;
                 foreach ($ass_data as $ass)
                 {
                         $worksheet2->writeString(0, $cnt, $cnt);
                         $cnt++;
                 }
                 $worksheet2->writeString(0, $cnt, ilExcelUtils::_convert_text($this->lng->txt("exc_total_exc")));
                 
                 // data rows
                 $data = array();
                 $row_cnt = 1;
                 reset($mems);
                 foreach ($mems as $user_id => $d)
                 {
                         $col_cnt = 1;
                         $d = ilObjUser::_lookupName($user_id);
 
                         // name
                         $worksheet2->writeString($row_cnt, 0,
                                 ilExcelUtils::_convert_text($d["lastname"].", ".$d["firstname"]." [".$d["login"]."]"));
 
                         reset($ass_data);
 
                         foreach ($ass_data as $ass)
                         {
                                 $mark = $ass->getMemberStatus($user_id)->getMark();
                                 $worksheet2->writeString($row_cnt, $col_cnt, ilExcelUtils::_convert_text($mark));
                                 $col_cnt++;
                         }
                         
                         // total mark
                         include_once 'Services/Tracking/classes/class.ilLPMarks.php';
                         $worksheet2->writeString($row_cnt, $col_cnt,
                                 ilExcelUtils::_convert_text(ilLPMarks::_lookupMark($user_id, $this->getId())));
 
                         $row_cnt++;
                 }
 
                 
                 $workbook->close();
                 $exc_name = ilUtil::getASCIIFilename(preg_replace("/\s/", "_", $this->getTitle()));
                 ilUtil::deliverFile($excelfile, $exc_name.".xls", "application/vnd.ms-excel");
         }

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 821 of file class.ilObjExercise.php.

Referenced by 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 80 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 100 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 120 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 140 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 68 of file class.ilObjExercise.php.

References $timestamp.

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

         {
                 return $this->timestamp;
         }

Here is the caller graph for this function:

◆ hasAddToDesktop()

ilObjExercise::hasAddToDesktop ( )

Add to desktop after hand-in.

Returns: bool

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

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

◆ 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 859 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)
                                 else if($certificate_visible == 0 && $status != "notgraded")
                                 {
                                         return true;
                                 }
                         }
                 }
                 return false;
         }

Here is the call graph for this function:

◆ ilObjExercise()

ilObjExercise::ilObjExercise	(	$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 50 of file class.ilObjExercise.php.

References ilObject\ilObject(), and setPassMode().

         {
                 $this->setPassMode("all");
                 $this->type = "exc";
                 $this->ilObject($a_id,$a_call_by_reference);
         }

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 734 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:

◆ notify()

ilObjExercise::notify	(	$a_event,
		$a_ref_id,
		$a_node_id,
		$a_params = `0`
	)

notifys an object about an event occured Based on the event happend, each object may decide how it reacts.

public

Parameters

string	event
integer	reference id of object where the event occured
array	passes optional paramters if required

Returns: boolean

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

         {
                 // object specific event handling
 
                 parent::notify($a_event,$a_ref_id,$a_node_id,$a_params);
         }

◆ processExerciseStatus()

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

Definition at line 755 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 285 of file class.ilObjExercise.php.

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

         {
                 global $ilDB;
 
                 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->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 843 of file class.ilObjExercise.php.

References $ilDB, and ilObject\getId().

         {
                 global $ilDB;
 
                 $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 162 of file class.ilObjExercise.php.

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

         {
                 global $ilDB;
                 
                 // SAVE ONLY EXERCISE SPECIFIC DATA
                 /*$query = "INSERT INTO exc_data SET ".
                         "obj_id = ".$ilDB->quote($this->getId()).", ".
                         "instruction = ".$ilDB->quote($this->getInstruction()).", ".
                         "time_stamp = ".$ilDB->quote($this->getTimestamp());
                 $this->ilias->db->query($query);*/
 
                 $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())
                         ));
                 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 360 of file class.ilObjExercise.php.

References $_SESSION, $file, $ilUser, ilObject\$lng, ilLink\_getLink(), ilDatePresentation\formatDate(), ilExAssignment\getDeadline(), ilExAssignment\getExerciseId(), ilFSStorageExercise\getFiles(), ilExAssignment\getId(), ilObjectFactory\getInstanceByObjId(), ilExAssignment\getInstruction(), ilExAssignment\getMemberStatus(), ilObject\getRefId(), ilExAssignment\getTitle(), ilObject\getTitle(), IL_CAL_UNIX, and ilMail\sendMail().

         {
                 global $lng, $ilUser;
                 
                 $a_members = array_keys($a_members);
                 
                 $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($_SESSION["AccountId"]);
                         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 700 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().

         {
                 $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 832 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 748 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 58 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 76 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 90 of file class.ilObjExercise.php.

Referenced by ilObjExercise().

         {
                 $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 110 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 130 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 72 of file class.ilObjExercise.php.

Referenced by read().

         {
                 $this->timestamp = $a_timestamp;
         }

Here is the caller graph for this function:

◆ update()

ilObjExercise::update ( )

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

References $ilDB, ilObject\getId(), getInstruction(), getPassMode(), getPassNr(), getShowSubmissions(), getTimestamp(), isCompletionBySubmissionEnabled(), and updateAllUsersStatus().

         {
                 global $ilDB;
 
                 parent::update();
 
                 /*$query = "UPDATE exc_data SET ".
                         "instruction = ".$ilDB->quote($this->getInstruction()).", ".
                         "time_stamp = ".$ilDB->quote($this->getTimestamp())." ".
                         "WHERE obj_id = ".$ilDB->quote($this->getId());
                 */
                 
                 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())
                         ), array(
                         "obj_id" => array("integer", $this->getId())
                         ));
 
                 $this->updateAllUsersStatus();
                 
                 //$res = $this->ilias->db->query($query);
 
                 #$this->members_obj->update();
                 return true;
         }

Here is the call graph for this function:

◆ updateAllUsersStatus()

ilObjExercise::updateAllUsersStatus ( )

Update status of all users.

Definition at line 557 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 538 of file class.ilObjExercise.php.

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

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

         {
                 global $ilUser;
                 
                 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 32 of file class.ilObjExercise.php.

◆ $completion_by_submission

ilObjExercise::$completion_by_submission = false

protected

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

Referenced by isCompletionBySubmissionEnabled().

◆ $day

ilObjExercise::$day

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

◆ $file_obj

ilObjExercise::$file_obj

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

◆ $files

ilObjExercise::$files

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

◆ $hour

ilObjExercise::$hour

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

◆ $instruction

ilObjExercise::$instruction

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

Referenced by getInstruction().

◆ $members_obj

ilObjExercise::$members_obj

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

◆ $minutes

ilObjExercise::$minutes

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

◆ $month

ilObjExercise::$month

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

◆ $timestamp

ilObjExercise::$timestamp

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

Referenced by getTimestamp().

◆ $year

ilObjExercise::$year

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

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 Attributes

Detailed Description

Member Function Documentation

◆ _lookupFinishedUserExercises()

◆ checkDate()

◆ cloneObject()

◆ delete()

◆ determinStatusOfUser()

◆ exportGradesExcel()

◆ getCertificateVisibility()

◆ getInstruction()

◆ getPassMode()

◆ getPassNr()

◆ getShowSubmissions()

◆ getTimestamp()

◆ hasAddToDesktop()

◆ hasUserCertificate()

◆ ilObjExercise()

◆ isCompletionBySubmissionEnabled()

◆ notify()

◆ processExerciseStatus()

◆ read()

◆ saveCertificateVisibility()

◆ saveData()

◆ sendAssignment()

◆ sendFeedbackFileNotification()

◆ setCertificateVisibility()

◆ setCompletionBySubmission()

◆ setDate()

◆ setInstruction()

◆ setPassMode()

◆ setPassNr()

◆ setShowSubmissions()

◆ setTimestamp()

◆ update()

◆ updateAllUsersStatus()

◆ updateUserStatus()

Field Documentation

◆ $certificate_visibility

◆ $completion_by_submission

◆ $day

◆ $file_obj

◆ $files

◆ $hour

◆ $instruction

◆ $members_obj

◆ $minutes

◆ $month

◆ $timestamp

◆ $year