XML writer class. More...

Inheritance diagram for ilUserXMLWriter:

Collaboration diagram for ilUserXMLWriter:

Public Member Functions
	__construct ()
	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
	__construct ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor More...

	_ilXmlWriter ()
	destructor public More...

	xmlSetDtdDef ($dtdDef)
	Sets dtd definition. More...

	xmlSetStSheet ($stSheet)
	Sets stylesheet. More...

	xmlSetGenCmt ($genCmt)
	Sets generated comment. 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 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 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...

Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. 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.

Constructor & Destructor Documentation

◆ __construct()

ilUserXMLWriter::__construct ( )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

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

References $DIC, $ilias, and $ilUser.

     {
         global $DIC;
 
         $ilias = $DIC['ilias'];
         $ilUser = $DIC['ilUser'];
 
         parent::__construct();
 
         $this->ilias = $ilias;
         $this->user_id = $ilUser->getId();
         $this->attachRoles = false;
         
         /*              $this->exportablePrefs = array(
                     "priv_feed_pass", "language", "style", "skin", 'ilPageEditor_HTMLMode',
                      'ilPageEditor_JavaScript', 'ilPageEditor_MediaMode', 'tst_javascript',
                      'tst_lastquestiontype', 'tst_multiline_answers', 'tst_use_previous_answers',
                     'graphicalAnswerSetting', "weekstart"
                 );*/
     }

Member Function Documentation

◆ __addElement()

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

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

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

Referenced by __addElementMulti(), and __handleUser().

     {
         if ($this->canExport($tagname, $settingsname)) {
             if (strlen($value) > 0 || $requiredTag || (is_array($attrs) && count($attrs) > 0)) {
                 $this->xmlElement($tagname, $attrs, $value);
             }
         }
     }

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 286 of file class.ilUserXMLWriter.php.

References __addElement().

Referenced by __handleUser().

     {
         if (is_array($value) && sizeof($value)) {
             foreach ($value as $idx => $item) {
                 $this->__addElement($tagname, $item, $attrs, $settingsname, $requiredTag);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildFooter()

ilUserXMLWriter::__buildFooter ( )

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

References ilXmlWriter\xmlEndTag().

Referenced by start().

     {
         $this->xmlEndTag('Users');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildHeader()

ilUserXMLWriter::__buildHeader ( )

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

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

Referenced by start().

     {
         $this->xmlSetDtdDef("<!DOCTYPE Users PUBLIC \"-//ILIAS//DTD UserImport//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_user_5_1.dtd\">");
         $this->xmlSetGenCmt("User of ilias system");
         $this->xmlHeader();
 
         $this->xmlStartTag('Users');
 
         return true;
     }

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 266 of file class.ilUserXMLWriter.php.

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

Referenced by __handleUser().

     {
         //todo nadia: test mail_address_option
         include_once("Services/Mail/classes/class.ilMailOptions.php");
         $mailOptions = new ilMailOptions($row["usr_id"]);
         $prefs["mail_incoming_type"] = $mailOptions->getIncomingType();
         $prefs["mail_address_option"] = $mailOptions->getMailAddressOption();
         $prefs["mail_signature"] = $mailOptions->getSignature();
         $prefs["mail_linebreak"] = $mailOptions->getLinebreak();
         if (count($prefs)) {
             $this->xmlStartTag("Prefs");
             foreach ($prefs as $key => $value) {
                 if (ilUserXMLWriter::isPrefExportable($key)) {
                     $this->xmlElement("Pref", array("key" => $key), $value);
                 }
             }
             $this->xmlEndTag("Prefs");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __handleUser()

ilUserXMLWriter::__handleUser ( $row )

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

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

Referenced by start().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $lng = $DIC['lng'];
         if (!is_array($this->settings)) {
             include_once('./Services/User/classes/class.ilObjUserFolder.php');
             $this->setSettings(ilObjUserFolder::getExportSettings());
         }
 
         $prefs = ilObjUser::_getPreferences($row["usr_id"]);
         
         if (strlen($row["language"]) == 0) {
             $row["language"] = $lng->getDefaultLanguage();
         }
 
         $attrs = array(
             'Id' => "il_" . IL_INST_ID . "_usr_" . $row["usr_id"],
             'Language' => $row["language"],
             'Action' => "Update"
         );
 
         $this->xmlStartTag("User", $attrs);
 
         $this->xmlElement("Login", null, $row["login"]);
 
         if ($this->attachRoles == true) {
             include_once './Services/AccessControl/classes/class.ilObjRole.php';
 
             $query = sprintf(
                 "SELECT object_data.title, object_data.description,  rbac_fa.* " .
                             "FROM object_data, rbac_ua, rbac_fa WHERE rbac_ua.usr_id = %s " .
                             "AND rbac_ua.rol_id = rbac_fa.rol_id AND object_data.obj_id = rbac_fa.rol_id",
                 $ilDB->quote($row["usr_id"], 'integer')
             );
             $rbacresult = $ilDB->query($query);
 
             while ($rbacrow = $rbacresult->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
                 if ($rbacrow["assign"] != "y") {
                     continue;
                 }
 
                 $type = "";
 
                 if ($rbacrow["parent"] == ROLE_FOLDER_ID) {
                     $type = "Global";
                 } else {
                     $type = "Local";
                 }
                 if (strlen($type)) {
                     $this->xmlElement(
                         "Role",
                         array("Id" =>
                                 "il_" . IL_INST_ID . "_role_" . $rbacrow["rol_id"], "Type" => $type),
                         $rbacrow["title"]
                     );
                 }
             }
         }
 
         $this->__addElement("Firstname", $row["firstname"]);
         $this->__addElement("Lastname", $row["lastname"]);
         $this->__addElement("Title", $row["title"]);
 
         if ($this->canExport("PersonalPicture", "upload")) {
             $imageData = $this->getPictureValue($row["usr_id"]);
             if ($imageData) {
                 $value = array_shift($imageData); //$imageData["value"];
                 $this->__addElement("PersonalPicture", $value, $imageData, "upload");
             }
         }
 
 
         $this->__addElement("Gender", $row["gender"]);
         $this->__addElement("Email", $row["email"]);
         $this->__addElement("SecondEmail", $row["second_email"], null, "second_email");
         $this->__addElement("Birthday", $row["birthday"]);
         $this->__addElement("Institution", $row["institution"]);
         $this->__addElement("Street", $row["street"]);
         $this->__addElement("City", $row["city"]);
         $this->__addElement("PostalCode", $row["zipcode"], null, "zipcode");
         $this->__addElement("Country", $row["country"]);
         $this->__addElement("SelCountry", $row["sel_country"], null, "sel_country");
         $this->__addElement("PhoneOffice", $row["phone_office"], null, "phone_office");
         $this->__addElement("PhoneHome", $row["phone_home"], null, "phone_home");
         $this->__addElement("PhoneMobile", $row["phone_mobile"], null, "phone_mobile");
         $this->__addElement("Fax", $row["fax"]);
         $this->__addElement("Hobby", $row["hobby"]);
         
         $this->__addElementMulti("GeneralInterest", $row["interests_general"], null, "interests_general");
         $this->__addElementMulti("OfferingHelp", $row["interests_help_offered"], null, "interests_help_offered");
         $this->__addElementMulti("LookingForHelp", $row["interests_help_looking"], null, "interests_help_looking");
         
         $this->__addElement("Department", $row["department"]);
         $this->__addElement("Comment", $row["referral_comment"], null, "referral_comment");
         $this->__addElement("Matriculation", $row["matriculation"]);
         $this->__addElement("Active", $row["active"] ? "true":"false");
         $this->__addElement("ClientIP", $row["client_ip"], null, "client_ip");
         $this->__addElement("TimeLimitOwner", $row["time_limit_owner"], null, "time_limit_owner");
         $this->__addElement("TimeLimitUnlimited", $row["time_limit_unlimited"], null, "time_limit_unlimited");
         $this->__addElement("TimeLimitFrom", $row["time_limit_from"], null, "time_limit_from");
         $this->__addElement("TimeLimitUntil", $row["time_limit_until"], null, "time_limit_until");
         $this->__addElement("TimeLimitMessage", $row["time_limit_message"], null, "time_limit_message");
         $this->__addElement("ApproveDate", $row["approve_date"], null, "approve_date");
         $this->__addElement("AgreeDate", $row["agree_date"], null, "agree_date");
 
         if (strlen($row["auth_mode"]) > 0) {
             $this->__addElement("AuthMode", null, array("type" => $row["auth_mode"]), "auth_mode", true);
         }
 
         if (strlen($row["ext_account"]) > 0) {
             $this->__addElement("ExternalAccount", $row["ext_account"], null, "ext_account", true);
         }
 
         if ($this->canExport("Look", "skin_style")) {
             $this->__addElement("Look", null, array(
                 "Skin" => $prefs["skin"], "Style" => $prefs["style"]
             ), "skin_style", true);
         }
 
 
         $this->__addElement("LastUpdate", $row["last_update"], null, "last_update");
         $this->__addElement("LastLogin", $row["last_login"], null, "last_login");
 
         include_once("./Services/User/classes/class.ilUserDefinedData.php");
         $udf_data = new ilUserDefinedData($row['usr_id']);
         $udf_data->addToXML($this, $this->settings);
 
         $this->__addElement("AccountInfo", $row["ext_account"], array("Type" => "external"));
 
         $this->__addElement("GMapsInfo", null, array(
             "longitude" => $row["longitude"],
             "latitude" => $row["latitude"],
             "zoom" => $row["loc_zoom"]));
 
         $this->__addElement("Feedhash", $row["feed_hash"]);
 
         if ($this->attachPreferences || $this->canExport("prefs", "preferences")) {
             $this->__handlePreferences($prefs, $row);
         }
         
         $this->xmlEndTag('User');
     }

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 304 of file class.ilUserXMLWriter.php.

References settings().

Referenced by __addElement(), and __handleUser().

     {
         return !is_array($this->settings) ||
                in_array(strtolower($tagname), $this->settings) !== false ||
                in_array($settingsname, $this->settings) !== false;
     }

Here is the call graph for this function:

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 381 of file class.ilUserXMLWriter.php.

Referenced by isPrefExportable().

     {
         return array(
                 'hits_per_page',
                 'public_city',
                 'public_country',
                 'public_department',
                 'public_email',
                 'public_second_email',
                 'public_fax',
                 'public_hobby',
                 'public_institution',
                 'public_matriculation',
                 'public_phone',
                 'public_phone_home',
                 'public_phone_mobile',
                 'public_phone_office',
                 'public_profile',
                 'public_street',
                 'public_upload',
                 'public_zip',
                 'send_info_mails',
                 /*'show_users_online',*/
                 'hide_own_online_status',
                 'bs_allow_to_contact_me',
                 'chat_osc_accept_msg',
                 'user_tz',
                 'weekstart',
                 'mail_incoming_type',
                 'mail_signature',
                 'mail_linebreak',
                 'public_interests_general',
                 'public_interests_help_offered',
                 'public_interests_help_looking'
         );
     }

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 326 of file class.ilUserXMLWriter.php.

References $DIC, $ilDB, $r, ilDBConstants\FETCHMODE_ASSOC, and ilUtil\getWebspaceDir().

Referenced by __handleUser().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         // personal picture
         $q = sprintf(
             "SELECT value FROM usr_pref WHERE usr_id = %s AND keyword = %s",
             $ilDB->quote($usr_id, "integer"),
             $ilDB->quote('profile_image', "text")
         );
         $r = $ilDB->query($q);
         if ($ilDB->numRows($r) == 1) {
             $personal_picture_data = $r->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
             $personal_picture = $personal_picture_data["value"];
             $webspace_dir = ilUtil::getWebspaceDir();
             $image_file = $webspace_dir . "/usr_images/" . $personal_picture;
             if (@is_file($image_file)) {
                 $fh = fopen($image_file, "rb");
                 if ($fh) {
                     $image_data = fread($fh, filesize($image_file));
                     fclose($fh);
                     $base64 = base64_encode($image_data);
                     $imagetype = "image/jpeg";
                     if (preg_match("/.*\.(png|gif)$/", $personal_picture, $matches)) {
                         $imagetype = "image/" . $matches[1];
                     }
                     return array(
                         "value" => $base64,
                         "encoding" => "Base64",
                         "imagetype" => $imagetype
                     );
                 }
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXML()

ilUserXMLWriter::getXML ( )

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

References ilXmlWriter\xmlDumpMem().

     {
         return $this->xmlDumpMem(false);
     }

Here is the call graph for this function:

◆ isPrefExportable()

static ilUserXMLWriter::isPrefExportable ( $key )

static

returns wether a key from db is exportable or not

Parameters

string $key

Returns: boolean

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

References $key, and getExportablePreferences().

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

     {
         return in_array($key, ilUserXMLWriter::getExportablePreferences());
     }

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 371 of file class.ilUserXMLWriter.php.

     {
         $this->attachPreferences = $attachPrefs;
     }

◆ setAttachRoles()

ilUserXMLWriter::setAttachRoles ( $value )

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

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

◆ setObjects()

ilUserXMLWriter::setObjects ( & $users )

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

References $users.

     {
         $this->users = &$users;
     }

◆ setSettings()

ilUserXMLWriter::setSettings ( $settings )

write access to settings

Parameters

array $settings

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

References $settings, and settings().

Referenced by __handleUser().

     {
         $this->settings = $settings;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ start()

ilUserXMLWriter::start ( )

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

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

     {
         if (!is_array($this->users)) {
             return false;
         }
 
         $this->__buildHeader();
 
 
         include_once("./Services/User/classes/class.ilUserDefinedFields.php");
         $udf_data = &ilUserDefinedFields::_getInstance();
         $udf_data->addToXML($this);
 
         foreach ($this->users as $user) {
             $this->__handleUser($user);
         }
 
         $this->__buildFooter();
 
         return true;
     }

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 __construct().

◆ $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:

Services/User/classes/class.ilUserXMLWriter.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __addElement()

◆ __addElementMulti()

◆ __buildFooter()

◆ __buildHeader()

◆ __handlePreferences()

◆ __handleUser()

◆ canExport()

◆ getExportablePreferences()

◆ getPictureValue()

◆ getXML()

◆ isPrefExportable()

◆ setAttachPreferences()

◆ setAttachRoles()

◆ setObjects()

◆ setSettings()

◆ start()

Field Documentation

◆ $attachPreferences

◆ $attachRoles

◆ $exportablePrefs

◆ $ilias

◆ $settings

◆ $user_id

◆ $users

◆ $xml