ilObjExercise Class Reference

Class ilObjExercise. More...

Inheritance diagram for ilObjExercise:

Collaboration diagram for ilObjExercise:

Public Member Functions
	ilObjExercise ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	setDate ($a_hour, $a_minutes, $a_day, $a_month, $a_year)
	getTimestamp ()
	setTimestamp ($a_timestamp)
	setInstruction ($a_instruction)
	getInstruction ()
	getFiles ()
	checkDate ()
	deliverFile ($a_http_post_files, $user_id, $unzip=false)
	addUploadedFile ($a_http_post_files, $unzipUploadedFile=false)
	deleteFiles ($a_files)
	saveData ()
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone exercise (no member data)
&	getDeliveredFiles ($user_id)
	Returns the delivered files of an user.
	deleteDeliveredFiles ($file_id_array, $user_id)
	Deletes already delivered files.
	deliverReturnedFiles ($user_id)
	Delivers the returned files of an user.
	delete ()
	delete course and all related data
	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.
	read ()
	update ()
	update object in db
	getMemberListData ()
	get member list data
	getLastSubmission ($member_id)
	Get the date of the last submission of a user for the exercise.
	send ($a_members)
	send exercise per mail to members
	_lookupUpdatedSubmission ($exc_id, $member_id)
	Check whether student has upload new files after tutor has set the exercise to another than notgraded.
	_lookupAnyExerciseSent ($a_exc_id)
	Check whether exercise has been sent to any student per mail.
	_lookupNewFiles ($exc_id, $member_id)
	Check how much files have been uploaded by the learner after the last download of the tutor.
	_lookupStatusTime ($exc_id, $member_id)
	Get time when exercise has been set to solved.
	_lookupSentTime ($exc_id, $member_id)
	Get time when exercise has been sent per e-mail to user.
	_lookupFeedbackTime ($exc_id, $member_id)
	Get time when feedback mail has been sent.
	__formatBody ()
	__formatSubject ()
	__formatRecipients ($a_members)
	_checkCondition ($a_exc_id, $a_operator, $a_value, $a_usr_id=0)
	processUploadedFile ($fileTmp, $storageMethod, $persistentErrorMessage)
	processes errorhandling etc for uploaded archive
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	_lookupObjIdByImportId ($a_import_id)
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ()
	create
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_getAllReferences ($a_id)
	get all reference ids of object
	_lookupOwner ($a_id)
	lookup object owner
	_lookupDescription ($a_id)
	lookup object description
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_lookupObjectId ($a_ref_id)
	lookup object id
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	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
	createRoleFolder ()
	creates a local role folder
	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.
	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.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.

Static Public Member Functions
static	_fixFilename ($a_filename)
	This function fixes filenames.
static	_fixFilenameArray ($a_array)
	Iterates an associative array and fixes all fields with the key "filename" using the _fixFilename() method.
Static Public Member Functions inherited from ilObject
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.

Data Fields
	$file_obj
	$members_obj
	$files
	$timestamp
	$hour
	$minutes
	$day
	$month
	$year
	$instruction
Data Fields inherited from ilObject
	$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

Detailed Description

Class ilObjExercise.

Author

Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Version

Id:

class.ilObjExercise.php 22746 2010-01-19 09:12:28Z akill

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

Member Function Documentation

ilObjExercise::__formatBody

(

)

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

References ilObject\$lng, ilFormat\formatDate(), getInstruction(), getTimestamp(), and ilObject\getType().

Referenced by send().

        {
                global $lng;

                $body = $this->getInstruction();
                $body .= "\n\n";
                $body .= $lng->txt("exc_edit_until") . ": ".
                        ilFormat::formatDate(date("Y-m-d H:i:s",$this->getTimestamp()), "datetime", true);
                $body .= "\n\n";
                $body .= ILIAS_HTTP_PATH.
                        "/goto.php?target=".
                        $this->getType().
                        "_".$this->getRefId()."&client_id=".CLIENT_ID;

                return $body;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::__formatRecipients

(

$a_members

)

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

References ilObjectFactory\getInstanceByObjId().

Referenced by send().

        {
                foreach($a_members as $member_id => $value)
                {
                        $tmp_obj = ilObjectFactory::getInstanceByObjId($member_id);
                        $tmp_members[] = $tmp_obj->getLogin();

                        unset($tmp_obj);
                }

                return implode(',',$tmp_members ? $tmp_members : array());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::__formatSubject

(

)

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

References ilObject\getDescription(), and ilObject\getTitle().

Referenced by send().

        {
                return $subject = $this->getTitle()." (".$this->getDescription().")";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::_checkCondition	(		$a_exc_id,
			$a_operator,
			$a_value,
			$a_usr_id = 0
	)

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

References ilExerciseMembers\_lookupStatus().

        {
                global $ilUser;
                
                $a_usr_id = $a_usr_id ? $a_usr_id : $ilUser->getId();

                switch($a_operator)
                {
                        case 'passed':
                                if (ilExerciseMembers::_lookupStatus($a_exc_id, $a_usr_id) == "passed")
                                {
                                        return true;
                                }
                                else
                                {
                                        return false;
                                }
                                break;

                        default:
                                return true;
                }
                return true;
        }

Here is the call graph for this function:

static ilObjExercise::_fixFilename (   $a_filename )

static

This function fixes filenames.

Prior to ILIAS 3.10.0 filenames have been stored with full path in exc_returned.filename, e.g. /opt/ilias/my_client/exercise/547/157/20070813113926_README.doc

Problems occur, if the server is moved from one location to another. We do the following: The filename will be parsed and if it contains the string "/exercise/" we truncate everything before "/exercise/" and replace it with the current CLIENT_DATA_DIR.

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

Referenced by _fixFilenameArray(), ilExerciseMembers\deleteDeliveredFiles(), ilExerciseMembers\deliverReturnedFiles(), and ilExerciseMembers\downloadSelectedFiles().

        {
                $ex_pos = strrpos($a_filename, "/exercise/");
                if ($ex_pos > 0)
                {
                        $a_filename = CLIENT_DATA_DIR.substr($a_filename, $ex_pos);
                }
                return $a_filename;
        }

Here is the caller graph for this function:

static ilObjExercise::_fixFilenameArray (   $a_array )

static

Iterates an associative array and fixes all fields with the key "filename" using the _fixFilename() method.

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

References _fixFilename().

Referenced by ilExerciseMembers\getAllDeliveredFiles(), and ilExerciseMembers\getDeliveredFiles().

        {
                if (is_array($a_array))
                {
                        foreach ($a_array as $k => $v)
                        {
                                if ($v["filename"] != "")
                                {
                                        $a_array[$k]["filename"] = ilObjExercise::_fixFilename($a_array[$k]["filename"]);
                                }
                        }
                }
                
                return $a_array;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::_lookupAnyExerciseSent

(

$a_exc_id

)

Check whether exercise has been sent to any student per mail.

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

References $ilDB, and $q.

        {
                global $ilDB;

                $q = "SELECT count(*) AS cnt FROM exc_members".
                        " WHERE NOT sent_time IS NULL".
                        " AND obj_id = ".$ilDB->quote($a_exc_id, "integer")." ".
                        " ";
                $set = $ilDB->query($q);
                $rec = $ilDB->fetchAssoc($set);

                if ($rec["cnt"] > 0)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

ilObjExercise::_lookupFeedbackTime	(		$exc_id,
			$member_id
	)

Get time when feedback mail has been sent.

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

References $ilDB, ilObject\$lng, $q, and ilUtil\getMySQLTimestamp().

Referenced by ilExerciseMemberTableGUI\fillRow().

        {

                global $ilDB, $lng;

                $q = "SELECT * ".
                "FROM exc_members ".
                "WHERE obj_id= ".$ilDB->quote($exc_id, "integer").
                " AND usr_id= ".$ilDB->quote($member_id, "integer");

                $set = $ilDB->query($q);
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return ilUtil::getMySQLTimestamp($rec["feedback_time"]);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::_lookupNewFiles	(		$exc_id,
			$member_id
	)

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

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

References $ilDB, and $q.

        {
                global $ilDB, $ilUser;

                $q = "SELECT exc_returned.returned_id AS id ".
                        "FROM exc_usr_tutor, exc_returned ".
                        "WHERE exc_returned.obj_id = exc_usr_tutor.obj_id ".
                        " AND exc_returned.user_id = exc_usr_tutor.usr_id ".
                        " AND exc_returned.obj_id = ".$ilDB->quote($exc_id, "integer").
                        " AND exc_returned.user_id = ".$ilDB->quote($member_id, "integer").
                        " AND exc_usr_tutor.tutor_id = ".$ilDB->quote($ilUser->getId(), "integer").
                        " AND exc_usr_tutor.download_time < exc_returned.ts ";

                $new_up_set = $ilDB->query($q);

                $new_up = array();
                while ($new_up_rec = $ilDB->fetchAssoc($new_up_set))
                {
                        $new_up[] = $new_up_rec["id"];
                }

                return $new_up;
        }

ilObjExercise::_lookupSentTime	(		$exc_id,
			$member_id
	)

Get time when exercise has been sent per e-mail to user.

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

References $ilDB, ilObject\$lng, $q, and ilUtil\getMySQLTimestamp().

Referenced by ilExerciseMemberTableGUI\fillRow().

        {

                global $ilDB, $lng;

                $q = "SELECT * ".
                "FROM exc_members ".
                "WHERE obj_id= ".$ilDB->quote($exc_id, "integer").
                " AND usr_id= ".$ilDB->quote($member_id, "integer");

                $set = $ilDB->query($q);
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return ilUtil::getMySQLTimestamp($rec["sent_time"]);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::_lookupStatusTime	(		$exc_id,
			$member_id
	)

Get time when exercise has been set to solved.

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

References $ilDB, ilObject\$lng, $q, and ilUtil\getMySQLTimestamp().

Referenced by ilExerciseMemberTableGUI\fillRow().

        {

                global $ilDB, $lng;

                $q = "SELECT * ".
                "FROM exc_members ".
                "WHERE obj_id= ".$ilDB->quote($exc_id, "integer").
                " AND usr_id= ".$ilDB->quote($member_id, "integer");

                $set = $ilDB->query($q);
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return ilUtil::getMySQLTimestamp($rec["status_time"]);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::_lookupUpdatedSubmission	(		$exc_id,
			$member_id
	)

Check whether student has upload new files after tutor has set the exercise to another than notgraded.

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

References $ilDB, ilObject\$lng, and $q.

        {

                global $ilDB, $lng;

                $q="SELECT exc_members.status_time, exc_returned.ts ".
                        "FROM exc_members, exc_returned ".
                        "WHERE exc_members.status_time < exc_returned.ts ".
                        "AND NOT exc_members.status_time IS NULL ".
                        "AND exc_returned.obj_id = exc_members.obj_id ".
                        "AND exc_returned.user_id = exc_members.usr_id ".
                        "AND exc_returned.obj_id=".$ilDB->quote($exc_id, "integer")." AND exc_returned.user_id=".
                        $ilDB->quote($member_id, "integer");

                $usr_set = $ilDB->query($q);

                $array = $ilDB->fetchAssoc($usr_set);

                if (count($array)==0)
                {
                        return 0;
                }
                else
                {
                        return 1;
                }

        }

ilObjExercise::addUploadedFile	(		$a_http_post_files,
			$unzipUploadedFile = false
	)

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

References ilObject\$lng, and processUploadedFile().

        {
                global $lng;
                if ($unzipUploadedFile && preg_match("/zip/",   $a_http_post_files["type"]) == 1)
                {

                        $this->processUploadedFile($a_http_post_files["tmp_name"], "storeUploadedFile", true);
                        return true;
                        
                        
                }
                else 
                {
                        $this->file_obj->storeUploadedFile($a_http_post_files, true);
                        return true;
                }
        }

Here is the call graph for this function:

ilObjExercise::checkDate

(

)

Definition at line 77 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);

        }

ilObjExercise::cloneObject	(		$a_target_id,
			$a_copy_id = 0
	)

Clone exercise (no member data)

public

Parameters

int	target ref_id
int	copy id

Reimplemented from ilObject.

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

References $ilDB, ilObject\getId(), getInstruction(), and getTimestamp().

        {
                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->saveData();
                
                // Copy files
                $tmp_file_obj =& new ilFileDataExercise($this->getId());
                $tmp_file_obj->ilClone($new_obj->getId());
                unset($tmp_file_obj);
                
                // 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:

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

Reimplemented from ilObject.

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

References $ilDB.

        {
                global $ilDB;

                // 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();

                return true;
        }

ilObjExercise::deleteDeliveredFiles	(		$file_id_array,
			$user_id
	)

Deletes already delivered files.

Parameters

array	$file_id_array	An array containing database ids of the delivered files
numeric	$user_id	The database id of the user public

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

        {
                $this->members_obj->deleteDeliveredFiles($file_id_array, $user_id);

                // Finally update status 'returned' of member if no file exists
                if(!count($this->members_obj->getDeliveredFiles($user_id)))
                {
                        $this->members_obj->setStatusReturnedForMember($user_id,0);
                }
        }

ilObjExercise::deleteFiles

(

$a_files

)

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

        {
                $this->file_obj->unlinkFiles($a_files);
        }

ilObjExercise::deliverFile	(		$a_http_post_files,
			$user_id,
			$unzip = false
	)

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

References $ilDB, $query, ilObject\getId(), and ilUtil\now().

        {
                global $ilDB;
                
                $deliver_result = $this->file_obj->deliverFile($a_http_post_files, $user_id, $unzip);
//var_dump($deliver_result);
                if ($deliver_result)
                {
                        $next_id = $ilDB->nextId("exc_returned");
                        $query = sprintf("INSERT INTO exc_returned ".
                                                         "(returned_id, obj_id, user_id, filename, filetitle, mimetype, ts) ".
                                                         "VALUES (%s, %s, %s, %s, %s, %s, %s)",
                                $ilDB->quote($next_id, "integer"),
                                $ilDB->quote($this->getId(), "integer"),
                                $ilDB->quote($user_id, "integer"),
                                $ilDB->quote($deliver_result["fullname"], "text"),
                                $ilDB->quote($a_http_post_files["name"], "text"),
                                $ilDB->quote($deliver_result["mimetype"], "text"),
                                $ilDB->quote(ilUtil::now(), "timestamp")
                        );
                        $ilDB->manipulate($query);
                        if (!$this->members_obj->isAssigned($user_id))
                        {
                                $this->members_obj->assignMember($user_id);
                        }
                        $this->members_obj->setStatusReturnedForMember($user_id, 1);
                }
                return true;
        }

Here is the call graph for this function:

ilObjExercise::deliverReturnedFiles

(

$user_id

)

Delivers the returned files of an user.

Parameters

numeric

$user_id

The database id of the user public

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

        {
                require_once "./Services/Utilities/classes/class.ilUtil.php";
        }

& ilObjExercise::getDeliveredFiles

(

$user_id

)

Returns the delivered files of an user.

Parameters

numeric

$user_id

The database id of the user

Returns

array An array containing the information on the delivered files public

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

        {
                $delivered_files =& $this->members_obj->getDeliveredFiles($user_id);
                return $delivered_files;
        }

ilObjExercise::getFiles

(

)

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

References $files.

        {
                return $this->files;
        }

ilObjExercise::getInstruction

(

)

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

References $instruction.

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

        {
                return $this->instruction;
        }

Here is the caller graph for this function:

ilObjExercise::getLastSubmission

(

$member_id

)

Get the date of the last submission of a user for the exercise.

Parameters

int

$member_id

User ID of member.

Returns

mixed false or mysql timestamp of last submission

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

References $ilDB, ilObject\$lng, $q, ilObject\getId(), and ilUtil\getMySQLTimestamp().

Referenced by getMemberListData().

        {
                global $ilDB, $lng;

                $q="SELECT obj_id,user_id,ts FROM exc_returned ".
                        "WHERE obj_id =".$ilDB->quote($this->getId(), "integer")." AND user_id=".
                        $ilDB->quote($member_id, "integer").
                        " ORDER BY ts DESC";

                $usr_set = $ilDB->query($q);

                $array = $ilDB->fetchAssoc($usr_set);
                if ($array["ts"]==NULL)
                {
                        return false;
                }
                else
                {
                        return ilUtil::getMySQLTimestamp($array["ts"]);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::getMemberListData

(

)

get member list data

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

References $ilDB, $login, $name, $q, ilObject\_exists(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilObject\_lookupType(), ilObject\getId(), and getLastSubmission().

        {
                global $ilDB;

                $mem = array();
                $q = "SELECT * FROM exc_members ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
                $set = $ilDB->query($q);
                while($rec = $ilDB->fetchAssoc($set))
                {
                        if (ilObject::_exists($rec["usr_id"]) &&
                                (ilObject::_lookupType($rec["usr_id"]) == "usr"))
                        {
                                $name = ilObjUser::_lookupName($rec["usr_id"]);
                                $login = ilObjUser::_lookupLogin($rec["usr_id"]);
                                $mem[] =
                                        array(
                                        "name" => $name["lastname"].", ".$name["firstname"],
                                        "login" => $login,
                                        "sent_time" => $rec["sent_time"],
                                        "submission" => $this->getLastSubmission($rec["usr_id"]),
                                        "status_time" => $rec["status_time"],
                                        "feedback_time" => $rec["feedback_time"],
                                        "usr_id" => $rec["usr_id"],
                                        "lastname" => $name["lastname"],
                                        "firstname" => $name["firstname"],
                                        "notice" => $rec["notice"],
                                        "status" => $rec["status"]                                      
                                        );
                        }
                }
                return $mem;
        }

Here is the call graph for this function:

ilObjExercise::getTimestamp

(

)

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

References $timestamp.

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

        {
                return $this->timestamp;
        }

Here is the caller graph for this function:

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

References ilObject\ilObject().

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

Here is the call graph for this function:

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

        {
                // object specific event handling

                parent::notify($a_event,$a_ref_id,$a_node_id,$a_params);
        }

ilObjExercise::processUploadedFile	(		$fileTmp,
			$storageMethod,
			$persistentErrorMessage
	)

processes errorhandling etc for uploaded archive

Parameters

string	$tmpFile	path and filename to uploaded file
string	$storageMethod	deliverFile or storeUploadedFile
boolean	$persistentErrorMessage	Defines whether sendInfo will be persistent or not

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

References $filename, $key, ilObject\$lng, ilUtil\delDir(), ilUtil\ilTempnam(), ilUtil\makeDir(), ilFileUtils\processZipFile(), ilFileUtils\recursive_dirscan(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and ilFileUtils\utf8_encode().

Referenced by addUploadedFile().

        {
                global $lng, $ilUser;

                // Create unzip-directory
                $newDir = ilUtil::ilTempnam();
                ilUtil::makeDir($newDir);

                include_once ("Services/Utilities/classes/class.ilFileUtils.php");
                
                try 
                {
                        $processDone = ilFileUtils::processZipFile($newDir,$fileTmp, false);
                        ilFileUtils::recursive_dirscan($newDir, $filearray);                    

                        foreach ($filearray["file"] as $key => $filename)
                        {
                                $a_http_post_files["name"] = ilFileUtils::utf8_encode($filename);
                                $a_http_post_files["type"] = "other";
                                $a_http_post_files["tmp_name"] = $filearray["path"][$key]."/".$filename;
                                $a_http_post_files["error"] = 0;
                                $a_http_post_files["size"] = filesize($filearray["path"][$key]."/".$filename);

                                if ($storageMethod == "deliverFile")
                                {
                                        $this->$storageMethod($a_http_post_files, $ilUser->id, true);
                                }
                                else if ($storageMethod == "storeUploadedFile")
                                {
                                        $this->file_obj->$storageMethod($a_http_post_files, true, true);                                
                                }
                        }
                        ilUtil::sendSuccess($this->lng->txt("file_added"),$persistentErrorMessage);                                     

                } 
                catch (ilFileUtilsException $e) 
                {
                        ilUtil::sendFailure($e->getMessage(), $persistentErrorMessage);
                }
                

                ilUtil::delDir($newDir);
                return $processDone;

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjExercise::read

(

)

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

References $ilDB, $query, $res, $row, ilObject\getId(), ilObject\getRefId(), setInstruction(), setTimestamp(), and ilUtil\sortArray().

        {
                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);
                }
                $this->members_obj =& new ilExerciseMembers($this->getId(),$this->getRefId());
                $this->members_obj->read();

                // GET FILE ASSIGNED TO EXERCISE
                $this->file_obj = new ilFileDataExercise($this->getId());
                $this->files = $this->file_obj->getFiles();
                $this->files = ilUtil::sortArray($this->files, "name", "asc");
                return true;
        }

Here is the call graph for this function:

ilObjExercise::saveData

(

)

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

References $ilDB, ilObject\getId(), getInstruction(), and getTimestamp().

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

Here is the call graph for this function:

ilObjExercise::send

(

$a_members

)

send exercise per mail to members

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

References $_SESSION, $file, $files, __formatBody(), __formatRecipients(), and __formatSubject().

        {
                $files = $this->file_obj->getFiles();
                if(count($files))
                {
                        include_once "./classes/class.ilFileDataMail.php";

                        $mfile_obj = new ilFileDataMail($_SESSION["AccountId"]);
                        foreach($files as $file)
                        {
                                $mfile_obj->copyAttachmentFile($this->file_obj->getAbsolutePath($file["name"]),$file["name"]);
                                $file_names[] = $file["name"];
                        }
                }

                include_once "Services/Mail/classes/class.ilMail.php";

                $tmp_mail_obj = new ilMail($_SESSION["AccountId"]);
                $message = $tmp_mail_obj->sendMail($this->__formatRecipients($a_members),"","",$this->__formatSubject(),$this->__formatBody(),
                                                                                   count($file_names) ? $file_names : array(),array("normal"));

                unset($tmp_mail_obj);

                if(count($file_names))
                {
                        $mfile_obj->unlinkFiles($file_names);
                        unset($mfile_obj);
                }


                // SET STATUS SENT FOR ALL RECIPIENTS
                foreach($a_members as $member_id => $value)
                {
                        $this->members_obj->setStatusSentForMember($member_id,1);
                }

                return true;
        }

Here is the call graph for this function:

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

Definition at line 46 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;
        }

ilObjExercise::setInstruction

(

$a_instruction

)

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

Referenced by read().

        {
                $this->instruction = $a_instruction;
        }

Here is the caller graph for this function:

ilObjExercise::setTimestamp

(

$a_timestamp

)

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

Referenced by read().

        {
                $this->timestamp = $a_timestamp;
        }

Here is the caller graph for this function:

ilObjExercise::update

(

)

update object in db

public

Returns

boolean true on success

Reimplemented from ilObject.

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

References $ilDB, ilObject\getId(), getInstruction(), and getTimestamp().

        {
                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());
                */
                
                $ilDB->update("exc_data", array(
                        "instruction" => array("clob", $this->getInstruction()),
                        "time_stamp" => array("integer", $this->getTimestamp())
                        ), array(
                        "obj_id" => array("integer", $this->getId())
                        ));

                //$res = $this->ilias->db->query($query);

                #$this->members_obj->update();
                return true;
        }

Here is the call graph for this function:

Field Documentation

ilObjExercise::$day

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

ilObjExercise::$file_obj

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

ilObjExercise::$files

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

Referenced by getFiles(), and send().

ilObjExercise::$hour

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

ilObjExercise::$instruction

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

Referenced by getInstruction().

ilObjExercise::$members_obj

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

ilObjExercise::$minutes

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

ilObjExercise::$month

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

ilObjExercise::$timestamp

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

Referenced by getTimestamp().

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