ilExerciseDataSet Class Reference

Exercise data set class. More...

Inheritance diagram for ilExerciseDataSet:

Collaboration diagram for ilExerciseDataSet:

Public Member Functions
	getSupportedVersions ($a_entity)
	Get supported versions.
	getXmlNamespace ($a_entity, $a_target_release)
	Get xml namespace.
	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data.
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record (export)
	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record.
Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor.
	init ($a_entity, $a_target_release)
	Init.
	readData ($a_entity, $a_version, $a_ids)
	Read data from DB.
	setExportDirectories ($a_relative, $a_absolute)
	Set export directories.
	setImportDirectory ($a_val)
	Set import directory.
	getImportDirectory ()
	Get import directory.
	setDSPrefix ($a_val)
	Set XML dataset namespace prefix.
	getDSPrefix ()
	Get XML dataset namespace prefix.
	getDSPrefixString ()
	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields.
	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string.
	getJsonRepresentation ()
	Get json representation.
	getXmlRepresentation ($a_entity, $a_target_release, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ...
	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_target_release, $a_ids, $a_field="")
	Add records xml.
	getNamespaces (&$namespaces, $a_entity, $a_target_release)
	Get xml namespaces.
	getJsonRecord ($a_set)
	Get json record for version.
	getXmlTypes ($a_entity, $a_version)
	Get xml types.
	getJsonTypes ($a_entity, $a_version)
	Get json types.
	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten)
	getXMLEntityTag ($a_entity, $a_target_release)
	Get entity tag.
	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten)
	setImport ($a_val)
	Set import object.
	getImport ()
	Get import object.

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity.
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data.

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt

Detailed Description

Exercise data set class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 13 of file class.ilExerciseDataSet.php.

Member Function Documentation

ilExerciseDataSet::getDependencies (   $a_entity,   $a_version,   $a_rec,   $a_ids  )

protected

Determine the dependent sets of data.

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

        {
                switch ($a_entity)
                {
                        case "exc":
                                return array (
                                        "exc_assignment" => array("ids" => $a_rec["Id"])
                                );
                }

                return false;
        }

ilExerciseDataSet::getSupportedVersions

(

$a_entity

)

Get supported versions.

Parameters

@return

Reimplemented from ilDataSet.

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

        {
                switch ($a_entity)
                {
                        case "exc":
                                return array("4.1.0");
                }
        }

ilExerciseDataSet::getTypes (   $a_entity,   $a_version  )

protected

Get field types for entity.

Parameters

@return

Reimplemented from ilDataSet.

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

        {
                if ($a_entity == "exc")
                {
                        switch ($a_version)
                        {
                                case "4.1.0":
                                        return array(
                                                "Id" => "integer",
                                                "Title" => "text",
                                                "Description" => "text",
                                                "PassMode" => "text",
                                                "PassNr" => "integer",
                                                "ShowSubmissions" => "integer");
                        }
                }

                if ($a_entity == "exc_assignment")
                {
                        switch ($a_version)
                        {
                                case "4.1.0":
                                        return array(
                                                "Id" => "integer",
                                                "ExerciseId" => "integer",
                                                "Deadline" => "text",
                                                "Instruction" => "text",
                                                "Title" => "text",
                                                "Mandatory" => "integer",
                                                "OrderNr" => "integer",
                                                "Dir" => "directory");
                        }
                }

        }

ilExerciseDataSet::getXmlNamespace	(		$a_entity,
			$a_target_release
	)

Get xml namespace.

Parameters

@return

Reimplemented from ilDataSet.

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

        {
                return "http://www.ilias.de/xml/Modules/Exercise/".$a_entity;
        }

ilExerciseDataSet::getXmlRecord	(		$a_entity,
			$a_version,
			$a_set
	)

Get xml record (export)

Parameters

array

abstract data record

Returns

array xml record

Reimplemented from ilDataSet.

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

References IL_CAL_DATETIME, and IL_CAL_UNIX.

        {
                if ($a_entity == "exc_assignment")
                {
                        // convert server dates to utc
                        if($a_set["StartTime"] != "")
                        {
                                $start = new ilDateTime($a_set["StartTime"], IL_CAL_UNIX);
                                $a_set["StartTime"] = $start->get(IL_CAL_DATETIME,'','UTC');
                        }
                        if($a_set["Deadline"] != "")
                        {
                                $deadline = new ilDateTime($a_set["Deadline"], IL_CAL_UNIX);
                                $a_set["Deadline"] = $deadline->get(IL_CAL_DATETIME,'','UTC');
                        }

                        include_once("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
                        $fstorage = new ilFSStorageExercise($a_set["ExerciseId"], $a_set["Id"]);
                        $a_set["Dir"] = $fstorage->getPath();

                }

                return $a_set;
        }

ilExerciseDataSet::importRecord	(		$a_entity,
			$a_types,
			$a_rec,
			$a_mapping,
			$a_schema_version
	)

Import record.

Parameters

@return

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

References $dir, ilFSStorageExercise\create(), ilDataSet\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), IL_CAL_DATETIME, IL_CAL_UNIX, and ilUtil\rCopy().

        {
//echo $a_entity;
//var_dump($a_rec);

                switch ($a_entity)
                {
                        case "exc":
                                include_once("./Modules/Exercise/classes/class.ilObjExercise.php");
                                
                                if($new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['Id']))
                                {
                                        $newObj = ilObjectFactory::getInstanceByObjId($new_id,false);
                                }
                                else
                                {
                                        $newObj = new ilObjExercise();
                                        $newObj->setType("exc");
                                        $newObj->create(true);
                                }
                                
                                $newObj->setTitle($a_rec["Title"]);
                                $newObj->setDescription($a_rec["Description"]);
                                $newObj->setPassMode($a_rec["PassMode"]);
                                $newObj->setPassNr($a_rec["PassNr"]);
                                $newObj->setShowSubmissions($a_rec["ShowSubmissions"]);
                                $newObj->update();
                                $newObj->saveData();
//var_dump($a_rec);
                                $this->current_exc = $newObj;

                                $a_mapping->addMapping("Modules/Exercise", "exc", $a_rec["Id"], $newObj->getId());
//var_dump($a_mapping->mappings["Services/News"]["news_context"]);
                                break;

                        case "exc_assignment":
                                $exc_id = $a_mapping->getMapping("Modules/Exercise", "exc", $a_rec["ExerciseId"]);
                                if ($exc_id > 0)
                                {
                                        if (is_object($this->current_exc) && $this->current_exc->getId() == $exc_id)
                                        {
                                                $exc = $this->current_exc;
                                        }
                                        else
                                        {
                                                include_once("./Modules/Exercise/classes/class.ilObjExercise.php");
                                                $exc = new ilObjExercise($exc_id, false);
                                        }

                                        include_once("./Modules/Exercise/classes/class.ilExAssignment.php");

                                        $ass = new ilExAssignment();
                                        $ass->setExerciseId($exc_id);
                                        
                                        if ($a_rec["StartTime"] != "")
                                        {
                                                $start = new ilDateTime($a_rec["StartTime"], IL_CAL_DATETIME, "UTC");
                                                $ass->setStartTime($start->get(IL_CAL_UNIX));
                                        }

                                        if ($a_rec["Deadline"] != "")
                                        {
                                                $deadline = new ilDateTime($a_rec["Deadline"], IL_CAL_DATETIME, "UTC");
                                                $ass->setDeadline($deadline->get(IL_CAL_UNIX));
                                        }
//var_dump($a_rec);
                                        $ass->setInstruction($a_rec["Instruction"]);
                                        $ass->setTitle($a_rec["Title"]);
                                        $ass->setMandatory($a_rec["Mandatory"]);
                                        $ass->setOrderNr($a_rec["OrderNr"]);
                                        $ass->save();

                                        include_once("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
                                        $fstorage = new ilFSStorageExercise($exc_id, $ass->getId());
                                        $fstorage->create();
                                        $dir = str_replace("..", "", $a_rec["Dir"]);
                                        if ($dir != "" && $this->getImportDirectory() != "")
                                        {
                                                $source_dir = $this->getImportDirectory()."/".$dir;
                                                $target_dir = $fstorage->getPath();
                                                ilUtil::rCopy($source_dir, $target_dir);
                                        }

                                        $a_mapping->addMapping("Modules/Exercise", "exc_assignment", $a_rec["Id"], $ass->getId());

                                }

                                break;
                }
        }

Here is the call graph for this function:

ilExerciseDataSet::readData	(		$a_entity,
			$a_version,
			$a_ids,
			$a_field = ""
	)

Read data.

Parameters

@return

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

References $ilDB, and ilDataSet\getDirectDataFromQuery().

        {
                global $ilDB;

                if (!is_array($a_ids))
                {
                        $a_ids = array($a_ids);
                }
                                
                if ($a_entity == "exc")
                {
                        switch ($a_version)
                        {
                                case "4.1.0":
                                        $this->getDirectDataFromQuery("SELECT exc_data.obj_id id, title, description, ".
                                                " pass_mode, pass_nr, show_submissions".
                                                " FROM exc_data JOIN object_data ON (exc_data.obj_id = object_data.obj_id) ".
                                                "WHERE ".
                                                $ilDB->in("exc_data.obj_id", $a_ids, false, "integer"));
                                        break;
                        }
                }

                if ($a_entity == "exc_assignment")
                {
                        switch ($a_version)
                        {
                                case "4.1.0":
                                        $this->getDirectDataFromQuery("SELECT id, exc_id exercise_id, time_stamp deadline, ".
                                                " instruction, title, start_time, mandatory, order_nr".
                                                " FROM exc_assignment ".
                                                "WHERE ".
                                                $ilDB->in("exc_id", $a_ids, false, "integer"));
                                        break;
                        }
                }

        }

Here is the call graph for this function:

---

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

• Modules/Exercise/classes/class.ilExerciseDataSet.php