ilUserDataSet Class Reference
Exercise data set class. More...
Inheritance diagram for ilUserDataSet:
Collaboration diagram for ilUserDataSet:
Public Member Functions | |
| getSupportedVersions () | |
| Get supported versions. More... | |
| getXmlNamespace ($a_entity, $a_schema_version) | |
| Get xml namespace. More... | |
| getXmlRecord ($a_entity, $a_version, $a_set) | |
| Get xml record. More... | |
| afterXmlRecordWriting ($a_entity, $a_version, $a_set) | |
| After xml record writing hook record. 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... | |
Data Fields | |
| $multi = array() | |
| 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 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... | |
Protected Attributes | |
| $temp_picture_dirs = array() | |
| Protected Attributes inherited from ilDataSet | |
| $current_installation_id = "" | |
| $db | |
| $ds_log | |
Detailed Description
Member Function Documentation
◆ afterXmlRecordWriting()
| ilUserDataSet::afterXmlRecordWriting | ( | $a_entity, | |
| $a_version, | |||
| $a_set | |||
| ) |
After xml record writing hook record.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 173 of file class.ilUserDataSet.php.
174 {
175 if ($a_entity == "usr_profile") {
176 // cleanup temp dirs for pictures
177 $tmp_dir = $this->temp_picture_dirs[$a_set["Id"]];
178 if ($tmp_dir != "" && is_dir($tmp_dir)) {
179 ilUtil::delDir($tmp_dir);
180 }
181 }
182 }
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
Definition: class.ilUtil.php:2305
References ilUtil\delDir().
Here is the call graph for this function:
◆ getDependencies()
|
protected |
Determine the dependent sets of data.
Definition at line 306 of file class.ilUserDataSet.php.
307 {
308 return false;
309 switch ($a_entity) {
310 case "personal_data":
311 return array(
312 "usr_profile" => array("ids" => $a_rec["Id"]),
313 "usr_setting" => array("ids" => $a_rec["Id"]),
314 "usr_multi" => array("ids" => $a_rec["Id"])
315 );
316 }
317 return false;
318 }
◆ getSupportedVersions()
| ilUserDataSet::getSupportedVersions | ( | ) |
Get supported versions.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 25 of file class.ilUserDataSet.php.
26 {
27 return array("4.3.0", "4.5.0", "5.1.0", "5.2.0", "5.3.0");
28 }
◆ getTypes()
|
protected |
Get field types for entity.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 47 of file class.ilUserDataSet.php.
48 {
49 // user profile type
50 if ($a_entity == "usr_profile") {
51 switch ($a_version) {
52 case "4.3.0":
53 case "4.5.0":
54 case "5.1.0":
55 case "5.2.0":
56 case "5.3.0":
57 return array(
58 "Id" => "integer",
59 "Username" => "text",
60 "Firstname" => "text",
61 "Lastname" => "text",
62 "Title" => "text",
63 "Birthday" => "text",
64 "Gender" => "text",
65 "Institution" => "text",
66 "Department" => "text",
67 "Street" => "text",
68 "Zipcode" => "text",
69 "City" => "text",
70 "Country" => "text",
71 "SelCountry" => "text",
72 "PhoneOffice" => "text",
73 "PhoneHome" => "text",
74 "PhoneMobile" => "text",
75 "Fax" => "text",
76 "Email" => "text",
77 "SecondEmail" => "text",
78 "Hobby" => "text",
79 "ReferralComment" => "text",
80 "Matriculation" => "text",
81 "Latitude" => "text",
82 "Longitude" => "text",
83 "LocZoom" => "text",
84 "Picture" => "directory"
85 );
86 }
87 }
88
89 if ($a_entity == "usr_setting") {
90 switch ($a_version) {
91 case "4.3.0":
92 case "4.5.0":
93 case "5.1.0":
94 case "5.2.0":
95 case "5.3.0":
96 return array(
97 "UserId" => "integer",
98 "Keyword" => "text",
99 "Value" => "text"
100 );
101 }
102 }
103
104 if ($a_entity == "personal_data") {
105 switch ($a_version) {
106 case "4.3.0":
107 case "4.5.0":
108 case "5.1.0":
109 case "5.2.0":
110 case "5.3.0":
111 return array(
112 "Id" => "integer"
113 );
114 }
115 }
116
117 if ($a_entity == "usr_multi") {
118 switch ($a_version) {
119 case "4.5.0":
120 case "5.1.0":
121 case "5.2.0":
122 case "5.3.0":
123 return array(
124 "UserId" => "integer",
125 "FieldId" => "text",
126 "Value" => "text"
127 );
128 }
129 }
130 }
◆ getXmlNamespace()
| ilUserDataSet::getXmlNamespace | ( | $a_entity, | |
| $a_schema_version | |||
| ) |
Get xml namespace.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 36 of file class.ilUserDataSet.php.
37 {
38 return "http://www.ilias.de/xml/Services/User/" . $a_entity;
39 }
◆ getXmlRecord()
| ilUserDataSet::getXmlRecord | ( | $a_entity, | |
| $a_version, | |||
| $a_set | |||
| ) |
Get xml record.
- Parameters
-
return
Reimplemented from ilDataSet.
Definition at line 139 of file class.ilUserDataSet.php.
140 {
141 global $ilLog;
142
143 if ($a_entity == "usr_profile") {
144 $tmp_dir = ilUtil::ilTempnam();
145 ilUtil::makeDir($tmp_dir);
146 include_once("./Services/User/classes/class.ilObjUser.php");
147
148 $im = ilObjUser::_getPersonalPicturePath(
149 $a_set["Id"],
150 "small",
151 true,
152 true
153 );
154
155 if ($im != "") {
157 }
158
159 $this->temp_picture_dirs[$a_set["Id"]] = $tmp_dir;
160
161 $a_set["Picture"] = $tmp_dir;
162 }
163
164 return $a_set;
165 }
static copyProfilePicturesToDirectory($a_user_id, $a_dir)
Get profile picture direcotory.
Definition: class.ilObjUser.php:3950
static ilTempnam($a_temp_path=null)
Create a temporary file in an ILIAS writable directory.
Definition: class.ilUtil.php:1578
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...
Definition: class.ilUtil.php:2201
References $ilLog, ilObjUser\copyProfilePicturesToDirectory(), ilUtil\ilTempnam(), and ilUtil\makeDir().
Here is the call graph for this function:
◆ importRecord()
| ilUserDataSet::importRecord | ( | $a_entity, | |
| $a_types, | |||
| $a_rec, | |||
| $a_mapping, | |||
| $a_schema_version | |||
| ) |
Import record.
- Parameters
-
return
Definition at line 327 of file class.ilUserDataSet.php.
328 {
330 //echo $a_entity;
331 //var_dump($a_rec);
332
333 switch ($a_entity) {
334 case "personal_data":
335 // only users themselves import their profiles!
336 // thus we can map the import id of the dataset to the current user
338 break;
339
340 case "usr_profile":
341 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["Id"]);
343 if (!isset($this->users[$usr_id])) {
345 }
346 $user = $this->users[$usr_id];
347 include_once("./Services/User/classes/class.ilUserProfile.php");
349 $prof->skipField("username");
350 $prof->skipField("password");
351 $prof->skipField("roles");
352 $prof->skipGroup("settings");
353 $fields = $prof->getStandardFields();
354 foreach ($fields as $k => $f) {
355 $up_k = $this->convertToLeadingUpper($k);
356 // only change fields, when it is possible in profile
359 $f["method"] != "" && isset($a_rec[$up_k])) {
360 $set_method = "set" . substr($f["method"], 3);
361 $user->{$set_method}(ilUtil::secureString($a_rec[$up_k]));
362 }
363 }
364
365 $user->setLatitude($a_rec["Latitude"]);
366 $user->setLongitude($a_rec["Longitude"]);
367 $user->setLocationZoom($a_rec["LocZoom"]);
368
369 $user->update();
370
371 // personal picture
373 if ($pic_dir != "" && is_dir($pic_dir)) {
374 $upload_file = $pic_dir . "/upload_" . $a_rec["Id"] . "pic";
375 if (is_file($upload_file)) {
376 ilObjUser::_uploadPersonalPicture($upload_file, $user->getId());
377 }
378 }
379 }
380 break;
381
382 case "usr_setting":
383 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["UserId"]);
385 if (!isset($this->users[$usr_id])) {
387 }
388 $user = $this->users[$usr_id];
390 }
391 break;
392
393 case "usr_multi":
394 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["UserId"]);
397 }
398 break;
399 }
400 }
Definition: class.ilObjUser.php:26
static _uploadPersonalPicture($tmp_file, $obj_id)
Create a personal picture image file from a temporary image file.
Definition: class.ilObjUser.php:3806
static userSettingVisible($a_setting)
Checks whether user setting is visible.
Definition: class.ilUserProfile.php:793
static secureString($a_str, $a_strip_html=true, $a_allow="")
Remove unsecure tags.
Definition: class.ilUtil.php:2473
References $ilSetting, $ilUser, ilObject\_lookupType(), ilObjUser\_uploadPersonalPicture(), ilDataSet\convertToLeadingUpper(), ilDataSet\getImportDirectory(), ilUtil\secureString(), and ilUserProfile\userSettingVisible().
Here is the call graph for this function:
◆ readData()
| ilUserDataSet::readData | ( | $a_entity, | |
| $a_version, | |||
| $a_ids, | |||
$a_field = "" |
|||
| ) |
Read data.
- Parameters
-
return
Definition at line 190 of file class.ilUserDataSet.php.
191 {
192 global $ilDB;
193
194 if (!is_array($a_ids)) {
195 $a_ids = array($a_ids);
196 }
197
198 if ($a_entity == "personal_data") {
199 switch ($a_version) {
200 case "4.3.0":
201 case "4.5.0":
202 case "5.1.0":
203 case "5.2.0":
204 case "5.3.0":
205 $this->data = array();
208 }
209 break;
210 }
211 }
212
213 if ($a_entity == "usr_profile") {
214 switch ($a_version) {
215 case "4.3.0":
216 case "4.5.0":
217 case "5.1.0":
219 " title, birthday, gender, institution, department, street, city, zipcode, country, sel_country, " .
220 " phone_office, phone_home, phone_mobile, fax, email, hobby, referral_comment, matriculation, " .
221 " delicious, latitude, longitude, loc_zoom" .
222 " FROM usr_data u " .
223 "WHERE " .
224 $ilDB->in("u.usr_id", $a_ids, false, "integer"));
225 break;
226
227 case "5.2.0":
229 " title, birthday, gender, institution, department, street, city, zipcode, country, sel_country, " .
230 " phone_office, phone_home, phone_mobile, fax, email, hobby, referral_comment, matriculation, " .
231 " latitude, longitude, loc_zoom" .
232 " FROM usr_data u " .
233 "WHERE " .
234 $ilDB->in("u.usr_id", $a_ids, false, "integer"));
235 break;
236 case "5.3.0":
238 " title, birthday, gender, institution, department, street, city, zipcode, country, sel_country, " .
239 " phone_office, phone_home, phone_mobile, fax, email, second_email, hobby, referral_comment, matriculation, " .
240 " latitude, longitude, loc_zoom" .
241 " FROM usr_data u " .
242 "WHERE " .
243 $ilDB->in("u.usr_id", $a_ids, false, "integer"));
244 break;
245 }
246 }
247
248 if ($a_entity == "usr_setting") {
249 switch ($a_version) {
250 case "4.3.0":
251 case "4.5.0":
252 case "5.1.0":
253 case "5.2.0":
254 case "5.3.0":
255 // for all user ids get data from usr_pref and mail options, create records user_id/name/value
256 $prefs = array("date_format", "day_end", "day_start", "bs_allow_to_contact_me", "chat_osc_accept_msg", "hide_own_online_status", "hits_per_page", "language",
257 "public_birthday", "puplic_city", "public_country", "public_delicious", "public_department", "public_email", "public_second_email",
258 "public_fax", "public_gender", "public_hobby", "public_im_aim", "public_im_icq", "public_im_jabber",
259 "public_im_msn", "public_im_skype", "public_im_voip", "public_im_yahoo", "public_institution", "public_location",
260 "public_matriculation", "public_phone_home", "public_phone_mobile", "public_phone_office",
261 "public_profile", "public_sel_country", "public_street", "public_title", "public_upload", "public_zipcode",
262 "screen_reader_optimization", "show_users_online",
263 "store_last_visited", "time_format", "user_tz", "weekstart",
264 "session_reminder_enabled", "session_reminder_lead_time", "usr_starting_point",
265 "char_selector_availability", "char_selector_definition");
266
267 if (version_compare($a_version, '5.2.0', '>=')) {
268 unset(
269 $prefs['public_im_aim'], $prefs['public_im_icq'], $prefs['public_im_jabber'],
270 $prefs['public_im_msn'], $prefs['public_im_skype'], $prefs['public_im_voip'],
271 $prefs['public_im_yahoo'], $prefs['public_delicious']
272 );
273 }
274
275 $this->data = array();
280 $this->data[] = array("UserId" => $rec["usr_id"], "Keyword" => $rec["keyword"], "Value" => $rec["value"]);
281 }
282 break;
283 }
284 }
285
286 if ($a_entity == "usr_multi") {
287 switch ($a_version) {
288 case "4.5.0":
289 case "5.1.0":
290 case "5.2.0":
291 case "5.3.0":
292 $this->data = array();
296 $this->data[] = array("UserId" => $rec["usr_id"], "FieldId" => $rec["field_id"], "Value" => $rec["value"]);
297 }
298 break;
299 }
300 }
301 }
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 $id, $ilDB, data, and ilDataSet\getDirectDataFromQuery().
Here is the call graph for this function:
Field Documentation
◆ $multi
| ilUserDataSet::$multi = array() |
Definition at line 17 of file class.ilUserDataSet.php.
◆ $temp_picture_dirs
|
protected |
Definition at line 15 of file class.ilUserDataSet.php.
The documentation for this class was generated from the following file:
- Services/User/classes/class.ilUserDataSet.php
