ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilUserXMLWriter Class Reference

XML writer class. More...

+ Inheritance diagram for ilUserXMLWriter:
+ Collaboration diagram for ilUserXMLWriter:

Public Member Functions

 ilUserXMLWriter ()
 constructor More...
 
 setAttachRoles ($value)
 
 setObjects (& $users)
 
 start ()
 
 getXML ()
 
 __buildHeader ()
 
 __buildFooter ()
 
 __handleUser ($row)
 
 __addElementMulti ($tagname, $value, $attrs=null, $settingsname=null, $requiredTag=false)
 
 __addElement ($tagname, $value, $attrs=null, $settingsname=null, $requiredTag=false)
 
 setSettings ($settings)
 write access to settings More...
 
 setAttachPreferences ($attachPrefs)
 if set to true, all preferences of a user will be set More...
 
- Public Member Functions inherited from ilXmlWriter
 ilXmlWriter ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
 constructor More...
 
 _ilXmlWriter ()
 destructor @access public More...
 
 xmlSetDtdDef ($dtdDef)
 Sets dtd definition. More...
 
 xmlSetStSheet ($stSheet)
 Sets stylesheet. More...
 
 xmlSetGenCmt ($genCmt)
 Sets generated comment. More...
 
 _xmlEscapeData ($data)
 Escapes reserved characters. More...
 
 xmlEncodeData ($data)
 Encodes text from input encoding into output encoding. More...
 
 xmlFormatData ($data)
 Indents text for better reading. More...
 
 xmlFormatElement ($array)
 Callback function for xmlFormatData; do not invoke directly. More...
 
 xmlHeader ()
 Writes xml header @access public. More...
 
 xmlStartTag ($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
 Writes a starttag. More...
 
 xmlEndTag ($tag)
 Writes an endtag. More...
 
 xmlComment ($comment)
 Writes a comment. More...
 
 xmlData ($data, $encode=TRUE, $escape=TRUE)
 Writes data. More...
 
 xmlElement ($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
 Writes a basic element (no children, just textual content) More...
 
 xmlDumpFile ($file, $format=TRUE)
 Dumps xml document from memory into a file. More...
 
 xmlDumpMem ($format=TRUE)
 Returns xml document from memory. More...
 
 appendXML ($a_str)
 append xml string to document More...
 
 xmlClear ()
 clears xmlStr @access public More...
 

Static Public Member Functions

static getExportablePreferences ()
 return exportable preference keys as found in db More...
 
static isPrefExportable ($key)
 returns wether a key from db is exportable or not More...
 

Data Fields

 $ilias
 
 $xml
 
 $users
 
 $user_id = 0
 
 $attachRoles = false
 
 $attachPreferences = false
 
- Data Fields inherited from ilXmlWriter
 $xmlStr
 
 $version
 
 $outEnc
 
 $inEnc
 
 $dtdDef = ""
 
 $stSheet = ""
 
 $genCmt = "Generated by ILIAS XmlWriter"
 

Private Member Functions

 __handlePreferences ($prefs, $row)
 
 canExport ($tagname, $settingsname=null)
 
 getPictureValue ($usr_id)
 return array with baseencoded picture data as key value, encoding type as encoding, and image type as key type. More...
 

Private Attributes

 $settings
 

Static Private Attributes

static $exportablePrefs
 

Detailed Description

XML writer class.

Class to simplify manual writing of xml documents. It only supports writing xml sequentially, because the xml document is saved in a string with no additional structure information. The author is responsible for well-formedness and validity of the xml document.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
Id
class.ilObjectXMLWriter.php,v 1.3 2005/11/04 12:50:24 smeyer Exp

Definition at line 20 of file class.ilUserXMLWriter.php.

Member Function Documentation

◆ __addElement()

ilUserXMLWriter::__addElement (   $tagname,
  $value,
  $attrs = null,
  $settingsname = null,
  $requiredTag = false 
)

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

306 {
307 if ($this->canExport($tagname, $settingsname))
308 {
309 if (strlen($value) > 0 || $requiredTag || (is_array($attrs) && count($attrs) > 0))
310 {
311 $this->xmlElement ($tagname, $attrs, $value);
312 }
313 }
314 }
canExport($tagname, $settingsname=null)
xmlElement($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
Writes a basic element (no children, just textual content)

References canExport(), and ilXmlWriter\xmlElement().

Referenced by __addElementMulti(), and __handleUser().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __addElementMulti()

ilUserXMLWriter::__addElementMulti (   $tagname,
  $value,
  $attrs = null,
  $settingsname = null,
  $requiredTag = false 
)

Definition at line 294 of file class.ilUserXMLWriter.php.

295 {
296 if(is_array($value) && sizeof($value))
297 {
298 foreach($value as $idx => $item)
299 {
300 $this->__addElement ($tagname, $item, $attrs, $settingsname, $requiredTag);
301 }
302 }
303 }
__addElement($tagname, $value, $attrs=null, $settingsname=null, $requiredTag=false)

References __addElement().

Referenced by __handleUser().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __buildFooter()

ilUserXMLWriter::__buildFooter ( )

Definition at line 114 of file class.ilUserXMLWriter.php.

115 {
116 $this->xmlEndTag('Users');
117 }
xmlEndTag($tag)
Writes an endtag.

References ilXmlWriter\xmlEndTag().

Referenced by start().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __buildHeader()

ilUserXMLWriter::__buildHeader ( )

Definition at line 103 of file class.ilUserXMLWriter.php.

104 {
105 $this->xmlSetDtdDef("<!DOCTYPE Users PUBLIC \"-//ILIAS//DTD UserImport//EN\" \"".ILIAS_HTTP_PATH."/xml/ilias_user_5_1.dtd\">");
106 $this->xmlSetGenCmt("User of ilias system");
107 $this->xmlHeader();
108
109 $this->xmlStartTag('Users');
110
111 return true;
112 }
xmlSetGenCmt($genCmt)
Sets generated comment.
xmlStartTag($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
Writes a starttag.
xmlHeader()
Writes xml header @access public.
xmlSetDtdDef($dtdDef)
Sets dtd definition.

References ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), ilXmlWriter\xmlSetGenCmt(), and ilXmlWriter\xmlStartTag().

Referenced by start().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __handlePreferences()

ilUserXMLWriter::__handlePreferences (   $prefs,
  $row 
)
private

Definition at line 274 of file class.ilUserXMLWriter.php.

275 {
276
277 include_once ("Services/Mail/classes/class.ilMailOptions.php");
278 $mailOptions = new ilMailOptions($row["usr_id"]);
279 $prefs["mail_incoming_type"] = $mailOptions->getIncomingType();
280 $prefs["mail_signature"] = $mailOptions->getSignature();
281 $prefs["mail_linebreak"] = $mailOptions->getLinebreak();
282 if (count($prefs))
283 {
284 $this->xmlStartTag("Prefs");
285 foreach ($prefs as $key => $value)
286 {
288 $this->xmlElement("Pref", array("key" => $key), $value);
289 }
290 $this->xmlEndTag("Prefs");
291 }
292 }
Class UserMail this class handles user mails.
static isPrefExportable($key)
returns wether a key from db is exportable or not

References $row, isPrefExportable(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by __handleUser().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ __handleUser()

ilUserXMLWriter::__handleUser (   $row)

Definition at line 119 of file class.ilUserXMLWriter.php.

120 {
121 global $ilDB,$lng;
122 if (!is_array ($this->settings)) {
123 include_once ('./Services/User/classes/class.ilObjUserFolder.php');
125 }
126
127 $prefs = ilObjUser::_getPreferences($row["usr_id"]);
128
129 if (strlen($row["language"]) == 0)
130 {
131 $row["language"] = $lng->getDefaultLanguage();
132
133 }
134
135 $attrs = array (
136 'Id' => "il_".IL_INST_ID."_usr_".$row["usr_id"],
137 'Language' => $row["language"],
138 'Action' => "Update"
139 );
140
141 $this->xmlStartTag("User", $attrs);
142
143 $this->xmlElement("Login", null, $row["login"]);
144
145 if ($this->attachRoles == TRUE)
146 {
147 include_once './Services/AccessControl/classes/class.ilObjRole.php';
148
149 $query = sprintf("SELECT object_data.title, object_data.description, rbac_fa.* ".
150 "FROM object_data, rbac_ua, rbac_fa WHERE rbac_ua.usr_id = %s ".
151 "AND rbac_ua.rol_id = rbac_fa.rol_id AND object_data.obj_id = rbac_fa.rol_id",
152 $ilDB->quote($row["usr_id"],'integer')
153 );
154 $rbacresult = $ilDB->query($query);
155
156 while ($rbacrow = $rbacresult->fetchRow(DB_FETCHMODE_ASSOC))
157 {
158 if ($rbacrow["assign"] != "y")
159 continue;
160
161 $type = "";
162
163 if ($rbacrow["parent"] == ROLE_FOLDER_ID)
164 {
165 $type = "Global";
166 }
167 else
168 {
169 $type = "Local";
170 }
171 if (strlen($type))
172 {
173 $this->xmlElement("Role",
174 array ("Id" =>
175 "il_".IL_INST_ID."_role_".$rbacrow["rol_id"], "Type" => $type),
176 $rbacrow["title"]);
177 }
178
179 }
180 }
181
182 $this->__addElement ("Firstname", $row["firstname"]);
183 $this->__addElement ("Lastname", $row["lastname"]);
184 $this->__addElement ("Title", $row["title"]);
185
186 if ($this->canExport("PersonalPicture", "upload"))
187 {
188 $imageData = $this->getPictureValue($row["usr_id"]);
189 if ($imageData)
190 {
191 $value = array_shift($imageData); //$imageData["value"];
192 $this->__addElement ("PersonalPicture", $value, $imageData, "upload");
193 }
194 }
195
196
197 $this->__addElement ("Gender", $row["gender"]);
198 $this->__addElement ("Email", $row["email"]);
199 $this->__addElement ("Birthday", $row["birthday"]);
200 $this->__addElement ("Institution", $row["institution"]);
201 $this->__addElement ("Street", $row["street"]);
202 $this->__addElement ("City", $row["city"]);
203 $this->__addElement ("PostalCode", $row["zipcode"], null, "zipcode");
204 $this->__addElement ("Country", $row["country"]);
205 $this->__addElement ("SelCountry", $row["sel_country"], null, "sel_country");
206 $this->__addElement ("PhoneOffice", $row["phone_office"], null, "phone_office");
207 $this->__addElement ("PhoneHome", $row["phone_home"], null, "phone_home");
208 $this->__addElement ("PhoneMobile", $row["phone_mobile"], null, "phone_mobile");
209 $this->__addElement ("Fax", $row["fax"]);
210 $this->__addElement ("Hobby", $row["hobby"]);
211
212 $this->__addElementMulti ("GeneralInterest", $row["interests_general"], null, "interests_general");
213 $this->__addElementMulti ("OfferingHelp", $row["interests_help_offered"], null, "interests_help_offered");
214 $this->__addElementMulti ("LookingForHelp", $row["interests_help_looking"], null, "interests_help_looking");
215
216 $this->__addElement ("Department", $row["department"]);
217 $this->__addElement ("Comment", $row["referral_comment"], null, "referral_comment");
218 $this->__addElement ("Matriculation", $row["matriculation"]);
219 $this->__addElement ("Active", $row["active"] ? "true":"false" );
220 $this->__addElement ("ClientIP", $row["client_ip"], null, "client_ip");
221 $this->__addElement ("TimeLimitOwner", $row["time_limit_owner"], null, "time_limit_owner");
222 $this->__addElement ("TimeLimitUnlimited", $row["time_limit_unlimited"], null, "time_limit_unlimited");
223 $this->__addElement ("TimeLimitFrom", $row["time_limit_from"], null, "time_limit_from");
224 $this->__addElement ("TimeLimitUntil", $row["time_limit_until"], null, "time_limit_until");
225 $this->__addElement ("TimeLimitMessage", $row["time_limit_message"], null, "time_limit_message");
226 $this->__addElement ("ApproveDate", $row["approve_date"], null, "approve_date");
227 $this->__addElement ("AgreeDate", $row["agree_date"], null, "agree_date");
228
229 if (strlen($row["auth_mode"])>0)
230 {
231 $this->__addElement ("AuthMode", null, array ("type" => $row["auth_mode"]),"auth_mode", true);
232 }
233
234 if (strlen($row["ext_account"])>0)
235 {
236 $this->__addElement ("ExternalAccount", $row["ext_account"], null, "ext_account", true);
237 }
238
239 if ($this->canExport("Look","skin_style"))
240 {
241 $this->__addElement("Look", null, array(
242 "Skin" => $prefs["skin"], "Style" => $prefs["style"]
243 ), "skin_style", true);
244
245 }
246
247
248 $this->__addElement ("LastUpdate", $row["last_update"], null, "last_update");
249 $this->__addElement ("LastLogin", $row["last_login"], null, "last_login");
250
251 include_once ("./Services/User/classes/class.ilUserDefinedData.php");
252 $udf_data = new ilUserDefinedData($row['usr_id']);
253 $udf_data->addToXML($this, $this->settings);
254
255 $msgrs = array ("skype" => "im_skype", "yahoo" => "im_yahoo", "msn"=>"im_msn", "aim"=>"im_aim", "icq"=>"im_icq", "delicious" => "delicious", "external" => "ext_account", "jabber" => "im_jabber", "voip" => "im_voip");
256 foreach ($msgrs as $type => $fieldname) {
257 $this->__addElement("AccountInfo", $row[$fieldname], array("Type" => $type), "instant_messengers");
258 }
259
260 $this->__addElement("GMapsInfo", null, array (
261 "longitude" => $row["longitude"],
262 "latitude" => $row["latitude"],
263 "zoom" => $row["loc_zoom"]));
264
265 $this->__addElement("Feedhash", $row["feed_hash"]);
266
267 if ($this->attachPreferences || $this->canExport("prefs", "preferences"))
268 $this->__handlePreferences ($prefs, $row);
269
270 $this->xmlEndTag('User');
271 }
const DB_FETCHMODE_ASSOC
Definition: class.ilDB.php:10
static getExportSettings()
getExport Settings
static _getPreferences($user_id)
get preferences for user
Class ilUserDefinedData.
setSettings($settings)
write access to settings
__handlePreferences($prefs, $row)
__addElementMulti($tagname, $value, $attrs=null, $settingsname=null, $requiredTag=false)
getPictureValue($usr_id)
return array with baseencoded picture data as key value, encoding type as encoding,...
global $lng
Definition: privfeed.php:40
global $ilDB

References $ilDB, $lng, $query, $row, __addElement(), __addElementMulti(), __handlePreferences(), ilObjUser\_getPreferences(), canExport(), DB_FETCHMODE_ASSOC, ilObjUserFolder\getExportSettings(), getPictureValue(), setSettings(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ canExport()

ilUserXMLWriter::canExport (   $tagname,
  $settingsname = null 
)
private

Definition at line 316 of file class.ilUserXMLWriter.php.

317 {
318 return !is_array($this->settings) ||
319 in_array(strtolower($tagname), $this->settings) !== FALSE ||
320 in_array($settingsname, $this->settings) !== FALSE;
321 }

Referenced by __addElement(), and __handleUser().

+ Here is the caller graph for this function:

◆ getExportablePreferences()

static ilUserXMLWriter::getExportablePreferences ( )
static

return exportable preference keys as found in db

Returns
array of string

Definition at line 390 of file class.ilUserXMLWriter.php.

390 {
391 return array (
392 'hits_per_page',
393 'public_city',
394 'public_country',
395 'public_department',
396 'public_email',
397 'public_fax',
398 'public_hobby',
399 'public_institution',
400 'public_matriculation',
401 'public_phone',
402 'public_phone_home',
403 'public_phone_mobile',
404 'public_phone_office',
405 'public_profile',
406 'public_street',
407 'public_upload',
408 'public_zip',
409 'send_info_mails',
410 /*'show_users_online',*/
411 'hide_own_online_status',
412 'bs_allow_to_contact_me',
413 'user_tz',
414 'weekstart',
415 'mail_incoming_type',
416 'mail_signature',
417 'mail_linebreak',
418 'public_interests_general',
419 'public_interests_help_offered',
420 'public_interests_help_looking'
421 );
422 }

Referenced by isPrefExportable().

+ Here is the caller graph for this function:

◆ getPictureValue()

ilUserXMLWriter::getPictureValue (   $usr_id)
private

return array with baseencoded picture data as key value, encoding type as encoding, and image type as key type.

Parameters
int$usr_id

Definition at line 337 of file class.ilUserXMLWriter.php.

337 {
338 global $ilDB;
339 // personal picture
340 $q = sprintf("SELECT value FROM usr_pref WHERE usr_id = %s AND keyword = %s",
341 $ilDB->quote($usr_id, "integer"), $ilDB->quote('profile_image', "text"));
342 $r = $ilDB->query($q);
343 if ($ilDB->numRows($r) == 1)
344 {
345 $personal_picture_data = $r->fetchRow(DB_FETCHMODE_ASSOC);
346 $personal_picture = $personal_picture_data["value"];
347 $webspace_dir = ilUtil::getWebspaceDir();
348 $image_file = $webspace_dir."/usr_images/".$personal_picture;
349 if (@is_file($image_file))
350 {
351 $fh = fopen($image_file, "rb");
352 if ($fh)
353 {
354 $image_data = fread($fh, filesize($image_file));
355 fclose($fh);
356 $base64 = base64_encode($image_data);
357 $imagetype = "image/jpeg";
358 if (preg_match("/.*\.(png|gif)$/", $personal_picture, $matches))
359 {
360 $imagetype = "image/".$matches[1];
361 }
362 return array (
363 "value" => $base64,
364 "encoding" => "Base64",
365 "imagetype" => $imagetype
366 );
367 }
368 }
369 }
370 return false;
371 }
static getWebspaceDir($mode="filesystem")
get webspace directory
$r
Definition: example_031.php:79

References $ilDB, $r, DB_FETCHMODE_ASSOC, and ilUtil\getWebspaceDir().

Referenced by __handleUser().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getXML()

ilUserXMLWriter::getXML ( )

Definition at line 97 of file class.ilUserXMLWriter.php.

98 {
99 return $this->xmlDumpMem(FALSE);
100 }
xmlDumpMem($format=TRUE)
Returns xml document from memory.

References ilXmlWriter\xmlDumpMem().

+ Here is the call graph for this function:

◆ ilUserXMLWriter()

ilUserXMLWriter::ilUserXMLWriter ( )

constructor

Parameters
stringxml version
stringoutput encoding
stringinput encoding @access public

Definition at line 44 of file class.ilUserXMLWriter.php.

45 {
46 global $ilias,$ilUser;
47
48 parent::ilXmlWriter();
49
50 $this->ilias =& $ilias;
51 $this->user_id = $ilUser->getId();
52 $this->attachRoles = false;
53
54/* $this->exportablePrefs = array(
55 "priv_feed_pass", "language", "style", "skin", 'ilPageEditor_HTMLMode',
56 'ilPageEditor_JavaScript', 'ilPageEditor_MediaMode', 'tst_javascript',
57 'tst_lastquestiontype', 'tst_multiline_answers', 'tst_use_previous_answers',
58 'graphicalAnswerSetting', "weekstart"
59 );*/
60 }
redirection script todo: (a better solution should control the processing via a xml file)
global $ilUser
Definition: imgupload.php:15

References $ilias, and $ilUser.

◆ isPrefExportable()

static ilUserXMLWriter::isPrefExportable (   $key)
static

returns wether a key from db is exportable or not

Parameters
string$key
Returns
boolean

Definition at line 430 of file class.ilUserXMLWriter.php.

430 {
431 return in_array($key, ilUserXMLWriter::getExportablePreferences());
432 }
static getExportablePreferences()
return exportable preference keys as found in db

References getExportablePreferences().

Referenced by __handlePreferences(), ilUserImportParser\importEndTag(), and ilUserImportParser\verifyPref().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setAttachPreferences()

ilUserXMLWriter::setAttachPreferences (   $attachPrefs)

if set to true, all preferences of a user will be set

Parameters
bool$attachPrefs

Definition at line 380 of file class.ilUserXMLWriter.php.

381 {
382 $this->attachPreferences = $attachPrefs;
383 }

◆ setAttachRoles()

ilUserXMLWriter::setAttachRoles (   $value)

Definition at line 62 of file class.ilUserXMLWriter.php.

63 {
64 $this->attachRoles = $value == 1? true : false;
65 }

◆ setObjects()

ilUserXMLWriter::setObjects ( $users)

Definition at line 67 of file class.ilUserXMLWriter.php.

68 {
69 $this->users = & $users;
70 }

References $users.

◆ setSettings()

ilUserXMLWriter::setSettings (   $settings)

write access to settings

Parameters
array$settings

Definition at line 328 of file class.ilUserXMLWriter.php.

328 {
329 $this->settings = $settings;
330 }

References $settings.

Referenced by __handleUser().

+ Here is the caller graph for this function:

◆ start()

ilUserXMLWriter::start ( )

Definition at line 73 of file class.ilUserXMLWriter.php.

74 {
75 if (!is_array($this->users))
76 return false;
77
78 $this->__buildHeader();
79
80
81 include_once ("./Services/User/classes/class.ilUserDefinedFields.php");
83 $udf_data->addToXML($this);
84
85 foreach ($this->users as $user)
86 {
87
88 $this->__handleUser ($user);
89
90 }
91
92 $this->__buildFooter();
93
94 return true;
95 }
static _getInstance()
Get instance.

References __buildFooter(), __buildHeader(), __handleUser(), and ilUserDefinedFields\_getInstance().

+ Here is the call graph for this function:

Field Documentation

◆ $attachPreferences

ilUserXMLWriter::$attachPreferences = false

Definition at line 27 of file class.ilUserXMLWriter.php.

◆ $attachRoles

ilUserXMLWriter::$attachRoles = false

Definition at line 26 of file class.ilUserXMLWriter.php.

◆ $exportablePrefs

ilUserXMLWriter::$exportablePrefs
staticprivate

Definition at line 28 of file class.ilUserXMLWriter.php.

◆ $ilias

ilUserXMLWriter::$ilias

Definition at line 22 of file class.ilUserXMLWriter.php.

Referenced by ilUserXMLWriter().

◆ $settings

ilUserXMLWriter::$settings
private

Definition at line 35 of file class.ilUserXMLWriter.php.

Referenced by setSettings().

◆ $user_id

ilUserXMLWriter::$user_id = 0

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

◆ $users

ilUserXMLWriter::$users

Definition at line 24 of file class.ilUserXMLWriter.php.

Referenced by setObjects().

◆ $xml

ilUserXMLWriter::$xml

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


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