Inheritance diagram for ilSessionDataSet:

Collaboration diagram for ilSessionDataSet:

Public Member Functions
	__construct ()

	setTargetId (int $target_id)

	getSupportedVersions ()
	Get supported versions. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record (export) More...

	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. More...

Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor. More...

	init ($a_entity, $a_schema_version)
	Init. More...

	getSupportedVersions ()
	Get supported version. More...

	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...

	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...

	setImportDirectory ($a_val)
	Set import directory. More...

	getImportDirectory ()
	Get import directory. More...

	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...

	getDSPrefix ()
	Get XML dataset namespace prefix. More...

	getDSPrefixString ()

	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...

	getJsonRepresentation ()
	Get json representation. More...

	getXmlRepresentation ( $a_entity, $a_schema_version, $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 ...> ... More...

	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...

	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...

	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...

	getJsonRecord ($a_set)
	Get json record for version. More...

	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...

	getJsonTypes ($a_entity, $a_version)
	Get json types. More...

	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...

	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...

	setImport ($a_val)
	Set import object. More...

	getImport ()
	Get import object. More...

	setCurrentInstallationId ($a_val)
	Set current installation id. More...

	getCurrentInstallationId ()
	Get current installation id. More...

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity. More...

	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. More...

	readDidacticTemplateType ($a_obj_ids)

	applyDidacticTemplate (ilObject $rep_object, $tpl_id)

Protected Member Functions inherited from ilDataSet
	getTypes ($a_entity, $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	createObjectExportId ($a_type, $a_id)
	Build ilias export id. More...

	parseObjectExportId ($a_id, $a_fallback_id=null)
	Parse export id. More...

Private Attributes
	$logger = null

	$target_id = 0

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt

const	EXPORT_NO_INST_ID = 1

const	EXPORT_ID_ILIAS_LOCAL = 2

const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3

const	EXPORT_ID_ILIAS_REMOTE = 4

const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5

const	EXPORT_ID = 6

const	EXPORT_ID_INVALID = 7

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

Detailed Description

Session 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.ilSessionDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilSessionDataSet::__construct ( )

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

References $DIC.

     {
         global $DIC;
 
         parent::__construct();
         $this->logger = $DIC->logger()->sess();
     }

Member Function Documentation

◆ applyDidacticTemplate()

ilSessionDataSet::applyDidacticTemplate	(	ilObject	$rep_object,
			$tpl_id
	)

protected

Parameters

ilObject	$rep_object
	$tpl_id

Definition at line 427 of file class.ilSessionDataSet.php.

References $template, ilObject\applyDidacticTemplate(), and ilDidacticTemplateSettings\getInstanceByObjectType().

Referenced by importRecord().

     {
         $this->logger->debug('Apply didactic template');
 
         if ((int) $tpl_id == 0) {
             $this->logger->debug('Default permissions');
             // Default template
             return;
         }
 
         $templates = ilDidacticTemplateSettings::getInstanceByObjectType('sess')->getTemplates();
         foreach ($templates as $template) {
             if ($template->isAutoGenerated()) {
                 $this->logger->debug('Apply first auto generated');
                 $rep_object->applyDidacticTemplate($template->getId());
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDependencies()

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

protected

Determine the dependent sets of data.

Definition at line 286 of file class.ilSessionDataSet.php.

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

◆ getSupportedVersions()

ilSessionDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

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

     {
         return array("4.1.0", "5.0.0", "5.1.0", '5.4.0');
     }

◆ getTypes()

ilSessionDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

Definition at line 69 of file class.ilSessionDataSet.php.

     {
         if ($a_entity == "sess") {
             switch ($a_version) {
                 case "4.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "Location" => "text",
                         "TutorName" => "text",
                         "TutorEmail" => "text",
                         "TutorPhone" => "text",
                         "Details" => "text",
                         "Registration" => "integer",
                         "EventStart" => "text",
                         "EventEnd" => "text",
                         "StartingTime" => "integer",
                         "EndingTime" => "integer",
                         "Fulltime" => "integer"
                         );
                 case "5.0.0":
                     return array(
                             "Id" => "integer",
                             "Title" => "text",
                             "Description" => "text",
                             "Location" => "text",
                             "TutorName" => "text",
                             "TutorEmail" => "text",
                             "TutorPhone" => "text",
                             "Details" => "text",
                             "Registration" => "integer",
                             "EventStart" => "text",
                             "EventEnd" => "text",
                             "StartingTime" => "integer",
                             "EndingTime" => "integer",
                             "Fulltime" => "integer",
                             "LimitedRegistration" => "integer",
                             "WaitingList" => "integer",
                             "LimitUsers" => "integer"
                     );
                 case "5.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "Location" => "text",
                         "TutorName" => "text",
                         "TutorEmail" => "text",
                         "TutorPhone" => "text",
                         "Details" => "text",
                         "Registration" => "integer",
                         "EventStart" => "text",
                         "EventEnd" => "text",
                         "StartingTime" => "integer",
                         "EndingTime" => "integer",
                         "Fulltime" => "integer",
                         "LimitedRegistration" => "integer",
                         "WaitingList" => "integer",
                         "AutoWait" => "integer",
                         "LimitUsers" => "integer",
                         "MinUsers" => "integer"
                     );
                 case "5.4.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "Location" => "text",
                         "TutorName" => "text",
                         "TutorEmail" => "text",
                         "TutorPhone" => "text",
                         "Details" => "text",
                         "Registration" => "integer",
                         "EventStart" => "text",
                         "EventEnd" => "text",
                         "StartingTime" => "integer",
                         "EndingTime" => "integer",
                         "Fulltime" => "integer",
                         "LimitedRegistration" => "integer",
                         "WaitingList" => "integer",
                         "AutoWait" => "integer",
                         "LimitUsers" => "integer",
                         "MinUsers" => "integer",
                         'MailMembers' => 'integer',
                         'ShowMembers' => 'integer',
                         'Type' => 'integer'
                     );
             }
         }
 
         if ($a_entity == "sess_item") {
             switch ($a_version) {
                 case "4.1.0":
                 case "5.0.0":
                 case "5.1.0":
                 case "5.4.0":
                     return array(
                         "SessionId" => "integer",
                         "ItemId" => "text",
                         );
             }
         }
     }

◆ getXmlNamespace()

ilSessionDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

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

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

◆ getXmlRecord()

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

Get xml record (export)

Parameters

array abstract data record

Returns: array xml record

Definition at line 262 of file class.ilSessionDataSet.php.

References ilObject\_lookupObjId().

     {
         if ($a_entity == "sess") {
             // convert server dates to utc
             if (!$a_set["Fulltime"]) {
                 // nothing has to be done here, since the dates are already stored in UTC
                 #$start = new ilDateTime($a_set["EventStart"], IL_CAL_DATETIME);
                 #$a_set["EventStart"] = $start->get(IL_CAL_DATETIME,'','UTC');
                 #$end = new ilDateTime($a_set["EventEnd"], IL_CAL_DATETIME);
                 #$a_set["EventEnd"] = $end->get(IL_CAL_DATETIME,'','UTC');
             }
         }
         if ($a_entity == "sess_item") {
             // make ref id an object id
             $a_set["ItemId"] = ilObject::_lookupObjId($a_set["ItemId"]);
         }
         return $a_set;
     }

Here is the call graph for this function:

◆ importRecord()

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

Import record.

Parameters

Definition at line 305 of file class.ilSessionDataSet.php.

References $end, $start, ilObject\_getAllReferences(), ilEventItems\addItem(), applyDidacticTemplate(), ilObjectFactory\getInstanceByRefId(), IL_CAL_DATETIME, and IL_CAL_UNIX.

     {
         switch ($a_entity) {
             case "sess":
                 include_once("./Modules/Session/classes/class.ilObjSession.php");
                 include_once("./Modules/Session/classes/class.ilSessionAppointment.php");
 
                 if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
                     $refs = ilObject::_getAllReferences($new_id);
                     $newObj = ilObjectFactory::getInstanceByRefId(end($refs), false);
                 } else {
                     $this->logger->debug('Session creation without existing instance');
                     $newObj = new ilObjSession();
                     $newObj->setType("sess");
                     $newObj->create(true);
                     $newObj->createReference();
                     $newObj->putInTree($this->target_id);
                     $newObj->setPermissions($this->target_id);
                 }
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 $newObj->setLocation($a_rec["Location"]);
                 $newObj->setName($a_rec["TutorName"]);
                 $newObj->setPhone($a_rec["TutorPhone"]);
                 $newObj->setEmail($a_rec["TutorEmail"]);
                 $newObj->setDetails($a_rec["Details"]);
 
                 switch ($a_schema_version) {
                     case "5.0.0":
                     case "5.1.0":
                         $newObj->setRegistrationType($a_rec["Registration"]);
 
                         $newObj->enableRegistrationUserLimit($a_rec["LimitedRegistration"]);
                         $newObj->setRegistrationMaxUsers($a_rec["LimitUsers"]);
                         $newObj->enableRegistrationWaitingList($a_rec["WaitingList"]);
 
                         if (isset($a_rec["MinUsers"])) {
                             $newObj->setRegistrationMinUsers($a_rec["MinUsers"]);
                         }
 
                         if (isset($a_rec["AutoWait"])) {
                             $newObj->setWaitingListAutoFill($a_rec["AutoWait"]);
                         }
                         break;
                     case '5.4.0':
                         if (isset($a_rec['MailMembers'])) {
                             $newObj->setMailToMembersType($a_rec['MailMembers']);
                         }
                         if (isset($a_rec['ShowMembers'])) {
                             $newObj->setShowMembers($a_rec['ShowMembers']);
                         }
                         $this->applyDidacticTemplate($newObj, $a_rec['Type']);
                         break;
                 }
 
                 $newObj->update(true);
 
                 $start = new ilDateTime($a_rec["EventStart"], IL_CAL_DATETIME, "UTC");
                 $end = new ilDateTime($a_rec["EventEnd"], IL_CAL_DATETIME, "UTC");
 //echo "<br>".$start->get(IL_CAL_UNIX);
 //echo "<br>".$start->get(IL_CAL_DATETIME);
                 $app = new ilSessionAppointment();
                 $app->setStart($a_rec["EventStart"]);
                 $app->setEnd($a_rec["EventEnd"]);
                 $app->setStartingTime($start->get(IL_CAL_UNIX));
                 $app->setEndingTime($end->get(IL_CAL_UNIX));
                 $app->toggleFullTime($a_rec["Fulltime"]);
                 $app->setSessionId($newObj->getId());
                 $app->create();
                 
                 //$newObj->setAppointments(array($app));
                 //$newObj->update();
 
                 $this->current_obj = $newObj;
                 $a_mapping->addMapping("Modules/Session", "sess", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping('Services/Object', 'objs', $a_rec['Id'], $newObj->getId());
                 $a_mapping->addMapping('Services/AdvancedMetaData', 'parent', $a_rec['Id'], $newObj->getId());
                 $a_mapping->addMapping(
                     "Services/MetaData",
                     "md",
                     $a_rec["Id"] . ":0:sess",
                     $newObj->getId() . ":0:sess"
                 );
                 
                 
 //var_dump($a_mapping->mappings["Services/News"]["news_context"]);
                 break;
 
             case "sess_item":
 
                 if ($obj_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['ItemId'])) {
                     $ref_id = current(ilObject::_getAllReferences($obj_id));
                     include_once './Modules/Session/classes/class.ilEventItems.php';
                     $evi = new ilEventItems($this->current_obj->getId());
                     $evi->addItem($ref_id);
                     $evi->update();
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

Definition at line 180 of file class.ilSessionDataSet.php.

References $DIC, $ilDB, ilDataSet\getDirectDataFromQuery(), and readDidacticTemplateType().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
                 
         if ($a_entity == "sess") {
             switch ($a_version) {
                 case "4.1.0":
                     $this->getDirectDataFromQuery($q = "SELECT ev.obj_id id, od.title title, od.description description, " .
                         " location, tutor_name, tutor_email, tutor_phone, details, registration, " .
                         " e_start event_start, e_end event_end, starting_time, ending_time, fulltime " .
                         " FROM event ev JOIN object_data od ON (ev.obj_id = od.obj_id) " .
                         " JOIN event_appointment ea ON (ev.obj_id = ea.event_id)  " .
                         "WHERE " .
                         $ilDB->in("ev.obj_id", $a_ids, false, "integer"));
                     break;
                 case "5.0.0":
                     $this->getDirectDataFromQuery($q = "SELECT ev.obj_id id, od.title title, odes.description description, " .
                             " location, tutor_name, tutor_email, tutor_phone, details, reg_type registration, " .
                             " reg_limited limited_registration, reg_waiting_list waiting_list, " .
                             " reg_limit_users limit_users, " .
                             " e_start event_start, e_end event_end, starting_time, ending_time, fulltime " .
                             " FROM event ev JOIN object_data od ON (ev.obj_id = od.obj_id) " .
                             " JOIN event_appointment ea ON (ev.obj_id = ea.event_id)  " .
                             " JOIN object_description odes ON (ev.obj_id = odes.obj_id) " .
                             "WHERE " .
                             $ilDB->in("ev.obj_id", $a_ids, false, "integer"));
                     break;
                 case "5.1.0":
                     $this->getDirectDataFromQuery($q = "SELECT ev.obj_id id, od.title title, odes.description description, " .
                         " location, tutor_name, tutor_email, tutor_phone, details, reg_type registration, " .
                         " reg_limited limited_registration, reg_waiting_list waiting_list, reg_auto_wait auto_wait, " .
                         " reg_limit_users limit_users, reg_min_users min_users, " .
                         " e_start event_start, e_end event_end, starting_time, ending_time, fulltime " .
                         " FROM event ev JOIN object_data od ON (ev.obj_id = od.obj_id) " .
                         " JOIN event_appointment ea ON (ev.obj_id = ea.event_id)  " .
                         " JOIN object_description odes ON (ev.obj_id = odes.obj_id) " .
                         "WHERE " .
                         $ilDB->in("ev.obj_id", $a_ids, false, "integer"));
                     break;
                 case "5.4.0":
                     $this->getDirectDataFromQuery($q = "SELECT ev.obj_id id, od.title title, odes.description description, " .
                         " location, tutor_name, tutor_email, tutor_phone, details, reg_type registration, " .
                         " reg_limited limited_registration, reg_waiting_list waiting_list, reg_auto_wait auto_wait, " .
                         " reg_limit_users limit_users, reg_min_users min_users, " .
                         " e_start event_start, e_end event_end, starting_time, ending_time, fulltime, mail_members, show_members " .
                         " FROM event ev JOIN object_data od ON (ev.obj_id = od.obj_id) " .
                         " JOIN event_appointment ea ON (ev.obj_id = ea.event_id)  " .
                         " JOIN object_description odes ON (ev.obj_id = odes.obj_id) " .
                         "WHERE " .
                         $ilDB->in("ev.obj_id", $a_ids, false, "integer"));
 
                     $this->readDidacticTemplateType($a_ids);
                     break;
             }
         }
 
         if ($a_entity == "sess_item") {
             switch ($a_version) {
                 case "4.1.0":
                 case "5.0.0":
                 case "5.1.0":
                     $this->getDirectDataFromQuery($q = "SELECT event_id session_id, item_id " .
                         " FROM event_items " .
                         "WHERE " .
                         $ilDB->in("event_id", $a_ids, false, "integer"));
                     break;
             }
         }
     }

Here is the call graph for this function:

◆ readDidacticTemplateType()

ilSessionDataSet::readDidacticTemplateType ( $a_obj_ids )

protected

Parameters

int[] $a_obj_ids

Definition at line 409 of file class.ilSessionDataSet.php.

References ilObject\_getAllReferences(), data, and ilDidacticTemplateObjSettings\lookupTemplateId().

Referenced by readData().

     {
         $ref_ids = [];
         $counter = 0;
         foreach ($a_obj_ids as $obj_id) {
             $ref_ids = ilObject::_getAllReferences($obj_id);
             foreach ($ref_ids as $ref_id) {
                 $tpl_id = ilDidacticTemplateObjSettings::lookupTemplateId($ref_id);
                 $this->data[$counter++]['Type'] = (int) $tpl_id;
                 break;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTargetId()

ilSessionDataSet::setTargetId ( int $target_id )

Parameters

int $target_id

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

References $target_id.

     {
         $this->target_id = $target_id;
     }

Field Documentation

◆ $logger

ilSessionDataSet::$logger = null

private

Definition at line 18 of file class.ilSessionDataSet.php.

◆ $target_id

ilSessionDataSet::$target_id = 0

private

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

Referenced by setTargetId().

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

Modules/Session/classes/class.ilSessionDataSet.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyDidacticTemplate()

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ importRecord()

◆ readData()

◆ readDidacticTemplateType()

◆ setTargetId()

Field Documentation

◆ $logger

◆ $target_id