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 = "" | |
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 174 of file class.ilUserDataSet.php.
175 {
176 if ($a_entity == "usr_profile")
177 {
178 // cleanup temp dirs for pictures
179 $tmp_dir = $this->temp_picture_dirs[$a_set["Id"]];
180 if ($tmp_dir != "" && is_dir($tmp_dir))
181 {
182 ilUtil::delDir($tmp_dir);
183 }
184 }
185 }
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
Definition: class.ilUtil.php:2501
References ilUtil\delDir().
Here is the call graph for this function:
◆ getDependencies()
|
protected |
Determine the dependent sets of data.
Definition at line 310 of file class.ilUserDataSet.php.
311 {
312 return false;
313 switch ($a_entity)
314 {
315 case "personal_data":
316 return array (
317 "usr_profile" => array("ids" => $a_rec["Id"]),
318 "usr_setting" => array("ids" => $a_rec["Id"]),
319 "usr_multi" => array("ids" => $a_rec["Id"])
320 );
321 }
322 return false;
323 }
◆ 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");
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 {
52 switch ($a_version)
53 {
54 case "4.3.0":
55 case "4.5.0":
56 case "5.1.0":
57 case "5.2.0":
58 return array(
59 "Id" => "integer",
60 "Username" => "text",
61 "Firstname" => "text",
62 "Lastname" => "text",
63 "Title" => "text",
64 "Birthday" => "text",
65 "Gender" => "text",
66 "Institution" => "text",
67 "Department" => "text",
68 "Street" => "text",
69 "Zipcode" => "text",
70 "City" => "text",
71 "Country" => "text",
72 "SelCountry" => "text",
73 "PhoneOffice" => "text",
74 "PhoneHome" => "text",
75 "PhoneMobile" => "text",
76 "Fax" => "text",
77 "Email" => "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 {
91 switch ($a_version)
92 {
93 case "4.3.0":
94 case "4.5.0":
95 case "5.1.0":
96 case "5.2.0":
97 return array(
98 "UserId" => "integer",
99 "Keyword" => "text",
100 "Value" => "text"
101 );
102 }
103 }
104
105 if ($a_entity == "personal_data")
106 {
107 switch ($a_version)
108 {
109 case "4.3.0":
110 case "4.5.0":
111 case "5.1.0":
112 case "5.2.0":
113 return array(
114 "Id" => "integer"
115 );
116 }
117 }
118
119 if ($a_entity == "usr_multi")
120 {
121 switch ($a_version)
122 {
123 case "4.5.0":
124 case "5.1.0":
125 case "5.2.0":
126 return array(
127 "UserId" => "integer",
128 "FieldId" => "text",
129 "Value" => "text"
130 );
131 }
132 }
133 }
◆ 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 142 of file class.ilUserDataSet.php.
143 {
144 global $ilLog;
145
146 if ($a_entity == "usr_profile")
147 {
148 $tmp_dir = ilUtil::ilTempnam();
149 ilUtil::makeDir($tmp_dir);
150 include_once("./Services/User/classes/class.ilObjUser.php");
151
153 true);
154
155 if ($im != "")
156 {
158 }
159
160 $this->temp_picture_dirs[$a_set["Id"]] = $tmp_dir;
161
162 $a_set["Picture"] = $tmp_dir;
163 }
164
165 return $a_set;
166 }
static copyProfilePicturesToDirectory($a_user_id, $a_dir)
Get profile picture direcotory.
Definition: class.ilObjUser.php:3960
static _getPersonalPicturePath($a_usr_id, $a_size="small", $a_force_pic=false, $a_prevent_no_photo_image=false)
Get path to personal picture.
Definition: class.ilObjUser.php:3887
static ilTempnam($a_temp_path=null)
Create a temporary file in an ILIAS writable directory.
Definition: class.ilUtil.php:1696
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...
Definition: class.ilUtil.php:2394
References $ilLog, ilObjUser\_getPersonalPicturePath(), 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 332 of file class.ilUserDataSet.php.
333 {
335//echo $a_entity;
336//var_dump($a_rec);
337
338 switch ($a_entity)
339 {
340 case "personal_data":
341 // only users themselves import their profiles!
342 // thus we can map the import id of the dataset to the current user
344 break;
345
346 case "usr_profile":
347 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["Id"]);
349 {
350 if (!isset($this->users[$usr_id]))
351 {
353 }
354 $user = $this->users[$usr_id];
355 include_once("./Services/User/classes/class.ilUserProfile.php");
357 $prof->skipField("username");
358 $prof->skipField("password");
359 $prof->skipField("roles");
360 $prof->skipGroup("settings");
361 $fields = $prof->getStandardFields();
362 foreach ($fields as $k => $f)
363 {
364 $up_k = $this->convertToLeadingUpper($k);
365 // only change fields, when it is possible in profile
368 $f["method"] != "" && isset($a_rec[$up_k]))
369 {
370 $set_method = "set".substr($f["method"], 3);
371 $user->{$set_method}(ilUtil::secureString($a_rec[$up_k]));
372// echo "<br>-setting-".$set_method."-".$a_rec[$up_k]."-";
373 }
374 }
375 $user->update();
376
377 // personal picture
379 if ($pic_dir != "" && is_dir($pic_dir))
380 {
381 $upload_file = $pic_dir."/upload_".$a_rec["Id"]."pic";
382 if (is_file($upload_file))
383 {
384 ilObjUser::_uploadPersonalPicture($upload_file, $user->getId());
385 }
386 }
387 }
388 break;
389
390 case "usr_setting":
391 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["UserId"]);
393 {
394 if (!isset($this->users[$usr_id]))
395 {
397 }
398 $user = $this->users[$usr_id];
400 }
401 break;
402
403 case "usr_multi":
404 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["UserId"]);
406 {
408 }
409 break;
410 }
411 }
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:3830
static userSettingVisible($a_setting)
Checks whether user setting is visible.
Definition: class.ilUserProfile.php:834
static secureString($a_str, $a_strip_html=true, $a_allow="")
Remove unsecure tags.
Definition: class.ilUtil.php:2673
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 193 of file class.ilUserDataSet.php.
194 {
195 global $ilDB;
196
197 if (!is_array($a_ids))
198 {
199 $a_ids = array($a_ids);
200 }
201
202 if ($a_entity == "personal_data")
203 {
204 switch ($a_version)
205 {
206 case "4.3.0":
207 case "4.5.0":
208 case "5.1.0":
209 case "5.2.0":
210 $this->data = array();
211 foreach ($a_ids as $id)
212 {
213 $this->data[] = array("Id" => $id);
214 }
215 break;
216 }
217 }
218
219 if ($a_entity == "usr_profile")
220 {
221 switch ($a_version)
222 {
223 case "4.3.0":
224 case "4.5.0":
225 case "5.1.0":
227 " title, birthday, gender, institution, department, street, city, zipcode, country, sel_country, ".
228 " phone_office, phone_home, phone_mobile, fax, email, hobby, referral_comment, matriculation, ".
229 " delicious, latitude, longitude, loc_zoom".
230 " FROM usr_data u ".
231 "WHERE ".
232 $ilDB->in("u.usr_id", $a_ids, false, "integer"));
233 break;
234
235 case "5.2.0":
237 " title, birthday, gender, institution, department, street, city, zipcode, country, sel_country, ".
238 " phone_office, phone_home, phone_mobile, fax, email, hobby, referral_comment, matriculation, ".
239 " latitude, longitude, loc_zoom".
240 " FROM usr_data u ".
241 "WHERE ".
242 $ilDB->in("u.usr_id", $a_ids, false, "integer"));
243 break;
244 }
245 }
246
247 if ($a_entity == "usr_setting")
248 {
249 switch ($a_version)
250 {
251 case "4.3.0":
252 case "4.5.0":
253 case "5.1.0":
254 case "5.2.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",
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 {
269 unset(
270 $prefs['public_im_aim'], $prefs['public_im_icq'], $prefs['public_im_jabber'],
271 $prefs['public_im_msn'], $prefs['public_im_skype'], $prefs['public_im_voip'],
272 $prefs['public_im_yahoo'], $prefs['public_delicious']
273 );
274 }
275
276 $this->data = array();
279 " AND ".$ilDB->in("usr_id", $a_ids, false, "integer"));
281 {
282 $this->data[] = array("UserId" => $rec["usr_id"], "Keyword" => $rec["keyword"], "Value" => $rec["value"]);
283 }
284 break;
285 }
286 }
287
288 if ($a_entity == "usr_multi")
289 {
290 switch ($a_version)
291 {
292 case "4.5.0":
293 case "5.1.0":
294 case "5.2.0":
295 $this->data = array();
299 {
300 $this->data[] = array("UserId" => $rec["usr_id"], "FieldId" => $rec["field_id"], "Value" => $rec["value"]);
301 }
302 break;
303 }
304 }
305 }
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:164
References $ilDB, 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
