ilCalendarDataSet Class Reference
Calendar data set class. More...
Inheritance diagram for ilCalendarDataSet:
Collaboration diagram for ilCalendarDataSet:
Public Member Functions | |
| 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... | |
| 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 ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> 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... | |
| 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... | |
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
Member Function Documentation
◆ getDependencies()
|
protected |
Determine the dependent sets of data.
Definition at line 189 of file class.ilCalendarDataSet.php.
190 {
191 switch ($a_entity) {
192 case "calendar":
193 include_once("./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php");
195 $entries = array();
196 foreach ($assignmnts as $cal_id) {
197 $entries[$cal_id] = $cal_id;
198 }
199 return array(
200 "cal_entry" => array("ids" => $entries),
201 "cal_assignment" => array("ids" => $a_rec["CatId"])
202 );
203 case "cal_entry":
204 return array(
205 "recurrence_rule" => array("ids" => $a_rec["Id"])
206 );
207 }
208
209 return false;
210 }
static _getAssignedAppointments($a_cat_id)
Get assigned apointments.
Definition: class.ilCalendarCategoryAssignments.php:125
References ilCalendarCategoryAssignments\_getAssignedAppointments().
Here is the call graph for this function:
◆ getSupportedVersions()
| ilCalendarDataSet::getSupportedVersions | ( | ) |
Get supported versions.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 21 of file class.ilCalendarDataSet.php.
22 {
23 return array("4.3.0");
24 }
◆ getTypes()
|
protected |
Get field types for entity.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 43 of file class.ilCalendarDataSet.php.
44 {
45 // calendar
46 if ($a_entity == "calendar") {
47 switch ($a_version) {
48 case "4.3.0":
49 return array(
50 "CatId" => "integer",
51 "ObjId" => "text",
52 "Title" => "text",
53 "Color" => "text",
54 "Type" => "integer"
55 );
56 }
57 }
58
59 // calendar entry
60 if ($a_entity == "cal_entry") {
61 switch ($a_version) {
62 case "4.3.0":
63 return array(
64 "Id" => "integer",
65 "Title" => "text",
66 "Subtitle" => "text",
67 "Description" => "text",
68 "Location" => "text",
69 "Fullday" => "integer",
70 "Starta" => "text",
71 "Enda" => "text",
72 "Informations" => "text",
73 "AutoGenerated" => "integer",
74 "ContextId" => "integer",
75 "TranslationType" => "integer",
76 "IsMilestone" => "integer",
77 "Completion" => "integer",
78 "Notification" => "integer"
79 );
80 }
81 }
82
83 // calendar/entry assignment
84 if ($a_entity == "cal_assignment") {
85 switch ($a_version) {
86 case "4.3.0":
87 return array(
88 "CatId" => "integer",
89 "EntryId" => "integer"
90 );
91 }
92 }
93
94 // recurrence rule
95 if ($a_entity == "recurrence_rule") {
96 switch ($a_version) {
97 case "4.3.0":
98 return array(
99 "RuleId" => "integer",
100 "EntryId" => "integer",
101 "CalRecurrence" => "integer",
102 "FreqType" => "text",
103 "FreqUntilDate" => "text",
104 "FreqUntilCount" => "integer",
105 "Intervall" => "integer",
106 "Byday" => "text",
107 "Byweekno" => "text",
108 "Bymonth" => "text",
109 "Bymonthday" => "text",
110 "Byyearday" => "text",
111 "Bysetpos" => "text",
112 "Weekstart" => "text"
113 );
114 }
115 }
116 }
◆ getXmlNamespace()
| ilCalendarDataSet::getXmlNamespace | ( | $a_entity, | |
| $a_schema_version | |||
| ) |
Get xml namespace.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 32 of file class.ilCalendarDataSet.php.
33 {
34 return "http://www.ilias.de/xml/Services/Calendar/" . $a_entity;
35 }
◆ importRecord()
| ilCalendarDataSet::importRecord | ( | $a_entity, | |
| $a_types, | |||
| $a_rec, | |||
| $a_mapping, | |||
| $a_schema_version | |||
| ) |
Import record.
- Parameters
-
return
Definition at line 218 of file class.ilCalendarDataSet.php.
219 {
220 switch ($a_entity) {
221 case "calendar":
222 // please note: we currently only support private user calendars to
223 // be imported
224 if ($a_rec["Type"] == 1) {
225 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["ObjId"]);
227 include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
229 $category->setTitle($a_rec["Title"]);
230 $category->setColor($a_rec["Color"]);
231 $category->setType(ilCalendarCategory::TYPE_USR);
232 $category->setObjId($usr_id);
233 $category->add();
234 $a_mapping->addMapping(
235 "Services/Calendar",
236 "calendar",
237 $a_rec["CatId"],
238 $category->getCategoryID()
239 );
240 }
241 }
242 break;
243
244 case "cal_entry":
245 // please note: we currently only support private user calendars to
246 // be imported
247 if ((int) $a_rec["ContextId"] == 0) {
248 include_once('./Services/Calendar/classes/class.ilCalendarEntry.php');
250 $entry->setTitle($a_rec["Title"]);
251 $entry->setSubtitle($a_rec["Subtitle"]);
252 $entry->setDescription($a_rec["Description"]);
253 $entry->setLocation($a_rec["Location"]);
254 $entry->setFullday($a_rec["Fullday"]);
255 if ($a_rec["Starta"] != "") {
257 }
258 if ($a_rec["Enda"] != "") {
260 }
261 $entry->setFurtherInformations($a_rec["Informations"]);
262 $entry->setAutoGenerated($a_rec["AutoGenerated"]);
263 $entry->setContextId($a_rec["ContextId"]);
264 $entry->setMilestone($a_rec["Milestone"]);
265 $entry->setCompletion($a_rec["Completion"]);
266 $entry->setTranslationType($a_rec["TranslationType"]);
267 $entry->enableNotification($a_rec["Notification"]);
268 $entry->save();
269 $a_mapping->addMapping(
270 "Services/Calendar",
271 "cal_entry",
272 $a_rec["Id"],
273 $entry->getEntryId()
274 );
275 }
276 break;
277
278 case "cal_assignment":
279 $cat_id = $a_mapping->getMapping("Services/Calendar", "calendar", $a_rec["CatId"]);
280 $entry_id = $a_mapping->getMapping("Services/Calendar", "cal_entry", $a_rec["EntryId"]);
281 if ($cat_id > 0 && $entry_id > 0) {
282 include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
284 $ass->addAssignment($cat_id);
285 }
286 break;
287
288 case "recurrence_rule":
289 $entry_id = $a_mapping->getMapping("Services/Calendar", "cal_entry", $a_rec["EntryId"]);
290 if ($entry_id > 0) {
291 include_once('./Services/Calendar/classes/class.ilCalendarRecurrence.php');
293 $rec->setEntryId($entry_id);
294 $rec->setRecurrence($a_rec["CalRecurrence"]);
295 $rec->setFrequenceType($a_rec["FreqType"]);
296 if ($a_rec["FreqUntilDate"] != "") {
298 }
299 $rec->setFrequenceUntilCount($a_rec["FreqUntilCount"]);
300 $rec->setInterval($a_rec["Interval"]);
301 $rec->setBYDAY($a_rec["Byday"]);
302 $rec->setBYWEEKNO($a_rec["Byweekno"]);
303 $rec->setBYMONTH($a_rec["Bymonth"]);
304 $rec->setBYMONTHDAY($a_rec["Bymonthday"]);
305 $rec->setBYYEARDAY($a_rec["Byyearday"]);
306 $rec->setBYSETPOS($a_rec["Bysetpos"]);
307 $rec->setWeekstart($a_rec["Weekstart"]);
308 $rec->save();
309 $a_mapping->addMapping(
310 "Services/Calendar",
311 "recurrence_rule",
312 $a_rec["RuleId"],
313 $rec->getRecurrenceId()
314 );
315 }
316 break;
317 }
318 }
References ilObject\_lookupType(), IL_CAL_DATETIME, and ilCalendarCategory\TYPE_USR.
Here is the call graph for this function:
◆ readData()
| ilCalendarDataSet::readData | ( | $a_entity, | |
| $a_version, | |||
| $a_ids, | |||
$a_field = "" |
|||
| ) |
Read data.
- Parameters
-
return
Definition at line 124 of file class.ilCalendarDataSet.php.
125 {
126 global $DIC;
127
129
130 if (!is_array($a_ids)) {
131 $a_ids = array($a_ids);
132 }
133
134 // calendar
135 if ($a_entity == "calendar") {
136 switch ($a_version) {
137 case "4.3.0":
139 " FROM cal_categories " .
140 " WHERE " .
142 break;
143 }
144 }
145
146 // cal assignments
147 if ($a_entity == "cal_assignment") {
148 switch ($a_version) {
149 case "4.3.0":
151 " FROM cal_cat_assignments " .
152 " WHERE " .
154 break;
155 }
156 }
157
158 // cal entries
159 if ($a_entity == "cal_entry") {
160 switch ($a_version) {
161 case "4.3.0":
162 $this->getDirectDataFromQuery("SELECT cal_id id, title, subtitle, description, location, fullday, " .
163 " starta, enda, informations, auto_generated, context_id, translation_type, is_milestone, completion, notification " .
164 " FROM cal_entries " .
165 " WHERE " .
167 break;
168 }
169 }
170
171
172 // recurrence_rule
173 if ($a_entity == "recurrence_rule") {
174 switch ($a_version) {
175 case "4.3.0":
176 $this->getDirectDataFromQuery("SELECT rule_id, cal_id entry_id, cal_recurrence, freq_type, freq_until_date, freq_until_count, " .
177 " intervall, byday, byweekno, bymonth, bymonthday, byyearday, bysetpos, weekstart " .
178 " FROM cal_recurrence_rules " .
179 " WHERE " .
181 break;
182 }
183 }
184 }
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 ...
Definition: class.ilDataSet.php:175
References $DIC, $ilDB, and ilDataSet\getDirectDataFromQuery().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- Services/Calendar/classes/class.ilCalendarDataSet.php
