Calendar data set class. More...

Inheritance diagram for ilCalendarDataSet:

Collaboration diagram for ilCalendarDataSet:

Public Member Functions
	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)

Public Member Functions inherited from ilDataSet
	__construct ()

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

	getSupportedVersions ()

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

	initByExporter (ilXmlExporter $xml_exporter)

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setDSPrefix (string $a_val)

	getDSPrefix ()

	getDSPrefixString ()

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

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

	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $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 (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)

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

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

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

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

	setImport (ilSurveyImporter $a_val)

	getImport ()

	setCurrentInstallationId (string $a_val)

	getCurrentInstallationId ()

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

	getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)

	getTypes (string $a_entity, string $a_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

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

	getXmlNamespace (string $a_entity, string $a_schema_version)

	getExportDirInContainer (string $exp_dir)

	getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

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

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

	stripTags (array $rec, array $omit_keys=[])

Additional Inherited Members
Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

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

int	$dircnt = 0

Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss

string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$component_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

ilExport	$export

Detailed Description

Calendar 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 12 of file class.ilCalendarDataSet.php.

Member Function Documentation

◆ getDependencies()

ilCalendarDataSet::getDependencies	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

Definition at line 170 of file class.ilCalendarDataSet.php.

References ilCalendarCategoryAssignments\_getAssignedAppointments().

      : array {
         switch ($a_entity) {
             case "calendar":
                 $assignmnts = ilCalendarCategoryAssignments::_getAssignedAppointments(array($a_rec["CatId"] ?? []));
                 $entries = array();
                 foreach ($assignmnts as $cal_id) {
                     $entries[$cal_id] = $cal_id;
                 }
                 return array(
                     "cal_entry" => array("ids" => $entries),
                     "cal_assignment" => array("ids" => $a_rec["CatId"] ?? null)
                 );
             case "cal_entry":
                 return array(
                     "recurrence_rule" => array("ids" => $a_rec["Id"] ?? null)
                 );
         }
 
         return [];
     }

Here is the call graph for this function:

◆ getSupportedVersions()

ilCalendarDataSet::getSupportedVersions ( )

Definition at line 17 of file class.ilCalendarDataSet.php.

                                           : array
     {
         return array("4.3.0");
     }

◆ getTypes()

ilCalendarDataSet::getTypes	(	string	$a_entity,
		string	$a_version
	)

protected

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

                                                                     : array
     {
         // calendar
         if ($a_entity == "calendar") {
             switch ($a_version) {
                 case "4.3.0":
                     return array(
                         "CatId" => "integer",
                         "ObjId" => "text",
                         "Title" => "text",
                         "Color" => "text",
                         "Type" => "integer"
                     );
             }
         }
 
         // calendar entry
         if ($a_entity == "cal_entry") {
             switch ($a_version) {
                 case "4.3.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Subtitle" => "text",
                         "Description" => "text",
                         "Location" => "text",
                         "Fullday" => "integer",
                         "Starta" => "text",
                         "Enda" => "text",
                         "Informations" => "text",
                         "AutoGenerated" => "integer",
                         "ContextId" => "integer",
                         "TranslationType" => "integer",
                         "Notification" => "integer"
                     );
             }
         }
 
         // calendar/entry assignment
         if ($a_entity == "cal_assignment") {
             switch ($a_version) {
                 case "4.3.0":
                     return array(
                         "CatId" => "integer",
                         "EntryId" => "integer"
                     );
             }
         }
 
         // recurrence rule
         if ($a_entity == "recurrence_rule") {
             switch ($a_version) {
                 case "4.3.0":
                     return array(
                         "RuleId" => "integer",
                         "EntryId" => "integer",
                         "CalRecurrence" => "integer",
                         "FreqType" => "text",
                         "FreqUntilDate" => "text",
                         "FreqUntilCount" => "integer",
                         "Intervall" => "integer",
                         "Byday" => "text",
                         "Byweekno" => "text",
                         "Bymonth" => "text",
                         "Bymonthday" => "text",
                         "Byyearday" => "text",
                         "Bysetpos" => "text",
                         "Weekstart" => "text"
                     );
             }
         }
         return [];
     }

◆ getXmlNamespace()

ilCalendarDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

protected

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

                                                                                   : string
     {
         return "http://www.ilias.de/xml/Services/Calendar/" . $a_entity;
     }

◆ importRecord()

ilCalendarDataSet::importRecord	(	string	$a_entity,
		array	$a_types,
		array	$a_rec,
		ilImportMapping	$a_mapping,
		string	$a_schema_version
	)

Definition at line 199 of file class.ilCalendarDataSet.php.

References ilObject\_lookupType(), ilImportMapping\addMapping(), ilImportMapping\getMapping(), IL_CAL_DATETIME, ILIAS\Repository\int(), and ilCalendarCategory\TYPE_USR.

      : void {
         switch ($a_entity) {
             case "calendar":
                 // please note: we currently only support private user calendars to
                 // be imported
                 if (($a_rec["Type"] ?? 0) == 1) {
                     $usr_id = (int) $a_mapping->getMapping("components/ILIAS/User", "usr", $a_rec["ObjId"]);
                     if ($usr_id > 0 && ilObject::_lookupType($usr_id) == "usr") {
                         $category = new ilCalendarCategory(0);
                         $category->setTitle((string) $a_rec["Title"]);
                         $category->setColor((string) $a_rec["Color"]);
                         $category->setType((int) ilCalendarCategory::TYPE_USR);
                         $category->setObjId((int) $usr_id);
                         $category->add();
                         $a_mapping->addMapping(
                             "components/ILIAS/Calendar",
                             "calendar",
                             $a_rec["CatId"],
                             (string) $category->getCategoryID()
                         );
                     }
                 }
                 break;
 
             case "cal_entry":
                 // please note: we currently only support private user calendars to
                 // be imported
                 if ((int) ($a_rec["ContextId"] ?? 0) == 0) {
                     $entry = new ilCalendarEntry(0);
                     $entry->setTitle((string) $a_rec["Title"]);
                     $entry->setSubtitle((string) $a_rec["Subtitle"]);
                     $entry->setDescription((string) $a_rec["Description"]);
                     $entry->setLocation((string) $a_rec["Location"]);
                     $entry->setFullday((bool) $a_rec["Fullday"]);
                     if ($a_rec["Starta"] != "") {
                         $entry->setStart(new ilDateTime($a_rec["Starta"], IL_CAL_DATETIME, 'UTC'));
                     }
                     if (($a_rec["Enda"] ?? '') != "") {
                         $entry->setEnd(new ilDateTime($a_rec["Enda"], IL_CAL_DATETIME, 'UTC'));
                     }
                     $entry->setFurtherInformations((string) ($a_rec["Informations"] ?? ''));
                     $entry->setAutoGenerated((bool) ($a_rec["AutoGenerated"] ?? false));
                     $entry->setContextId((int) ($a_rec["ContextId"] ?? 0));
                     $entry->setTranslationType((int) ($a_rec["TranslationType"] ?? 0));
                     $entry->enableNotification((bool) ($a_rec["Notification"] ?? false));
                     $entry->save();
                     $a_mapping->addMapping(
                         "components/ILIAS/Calendar",
                         "cal_entry",
                         $a_rec["Id"],
                         (string) $entry->getEntryId()
                     );
                 }
                 break;
 
             case "cal_assignment":
                 $cat_id = (int) $a_mapping->getMapping("components/ILIAS/Calendar", "calendar", $a_rec["CatId"]);
                 $entry_id = (int) $a_mapping->getMapping("components/ILIAS/Calendar", "cal_entry", $a_rec["EntryId"]);
                 if ($cat_id > 0 && $entry_id > 0) {
                     $ass = new ilCalendarCategoryAssignments($entry_id);
                     $ass->addAssignment($cat_id);
                 }
                 break;
 
             case "recurrence_rule":
                 $entry_id = $a_mapping->getMapping("components/ILIAS/Calendar", "cal_entry", $a_rec["EntryId"]);
                 if ($entry_id > 0) {
                     $rec = new ilCalendarRecurrence();
                     $rec->setEntryId((int) $entry_id);
                     $rec->setRecurrence((int) $a_rec["CalRecurrence"]);
                     $rec->setFrequenceType((string) $a_rec["FreqType"]);
                     if ($a_rec["FreqUntilDate"] != "") {
                         $rec->setFrequenceUntilDate(new ilDateTime((string) $a_rec["FreqUntilDate"], IL_CAL_DATETIME));
                     }
                     $rec->setFrequenceUntilCount((int) $a_rec["FreqUntilCount"]);
                     $rec->setInterval((int) ($a_rec["Interval"] ?? 0));
                     $rec->setBYDAY((string) ($a_rec["Byday"] ?? ''));
                     $rec->setBYWEEKNO((string) ($a_rec["Byweekno"] ?? ''));
                     $rec->setBYMONTH((string) ($a_rec["Bymonth"] ?? ''));
                     $rec->setBYMONTHDAY((string) ($a_rec["Bymonthday"] ?? ''));
                     $rec->setBYYEARDAY((string) ($a_rec["Byyearday"] ?? ''));
                     $rec->setBYSETPOS((string) ($a_rec["Bysetpos"] ?? ''));
                     $rec->setWeekstart((string) ($a_rec["Weekstart"] ?? ''));
                     $rec->save();
                     $a_mapping->addMapping(
                         "components/ILIAS/Calendar",
                         "recurrence_rule",
                         $a_rec["RuleId"],
                         (string) $rec->getRecurrenceId()
                     );
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

ilCalendarDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

Definition at line 110 of file class.ilCalendarDataSet.php.

References ilDataSet\getDirectDataFromQuery().

                                                                                : void
     {
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
 
         // calendar
         if ($a_entity == "calendar") {
             switch ($a_version) {
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT cat_id, obj_id, title, color, type " .
                         " FROM cal_categories " .
                         " WHERE " .
                         $this->db->in("cat_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         // cal assignments
         if ($a_entity == "cal_assignment") {
             switch ($a_version) {
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT cat_id, cal_id entry_id " .
                         " FROM cal_cat_assignments " .
                         " WHERE " .
                         $this->db->in("cat_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         // cal entries
         if ($a_entity == "cal_entry") {
             switch ($a_version) {
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT cal_id id, title, subtitle, description, location, fullday, " .
                         " starta, enda, informations, auto_generated, context_id, translation_type, notification " .
                         " FROM cal_entries " .
                         " WHERE " .
                         $this->db->in("cal_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         // recurrence_rule
         if ($a_entity == "recurrence_rule") {
             switch ($a_version) {
                 case "4.3.0":
                     $this->getDirectDataFromQuery("SELECT rule_id, cal_id entry_id, cal_recurrence, freq_type, freq_until_date, freq_until_count, " .
                         " intervall, byday, byweekno, bymonth, bymonthday, byyearday, bysetpos, weekstart " .
                         " FROM cal_recurrence_rules " .
                         " WHERE " .
                         $this->db->in("cal_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:

components/ILIAS/Calendar/classes/class.ilCalendarDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()