XML writer class Class to simplify manual writing of xml documents. More...

Inheritance diagram for ilUserXMLWriter:

Collaboration diagram for ilUserXMLWriter:

Public Member Functions
	setAttachRoles (bool $value)

	setObjects (array $users)

	start ()

	getXML ()

	__buildHeader ()

	__buildFooter ()

	__handleUser (array $row)

	__addElementMulti (string $tagname, array $value, ?array $attrs=null, ?string $settingsname=null, bool $requiredTag=false)

	__addElement (string $tagname, ?string $value, array $attrs=null, ?string $settingsname=null, bool $requiredTag=false)

	setSettings (array $settings)

	setAttachPreferences (bool $attach_preferences)
	if set to true, all preferences of a user will be set More...

Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")

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

	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...

	xmlFormatData (string $data)
	Indents text for better reading. More...

	xmlHeader ()
	Writes xml header. More...

	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...

	xmlEndTag (string $tag)
	Writes an endtag. More...

	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...

	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...

	appendXML (string $a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr More...

Static Public Member Functions
static	getExportablePreferences ()
	return exportable preference keys as found in db More...

static	isPrefExportable (string $key)
	returns wether a key from db is exportable or not More...

Private Member Functions
	__handlePreferences (array $prefs, array $row)

	canExport (string $tagname, ?string $settingsname=null)

	getPictureValue (int $usr_id)
	return array with base-encoded picture data as key value, encoding type as encoding, and image type as key type. More...

Private Attributes
ILIAS	$ilias

ilDBInterface	$db

Language	$lng

array	$users

int	$user_id = 0

bool	$attach_roles = false

bool	$attach_preferences = false

array	$settings = []
	fields to be exported More...

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

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

Member Function Documentation

◆ __addElement()

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

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

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

Referenced by __addElementMulti(), and __handleUser().

      : void {
         if ($this->canExport($tagname, $settingsname)
             && ($value !== null
                 || $requiredTag
                 || is_array($attrs) && count($attrs) > 0)) {
             $this->xmlElement($tagname, $attrs, (string) $value);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __addElementMulti()

ilUserXMLWriter::__addElementMulti	(	string	$tagname,
		array	$value,
		?array	$attrs = `null`,
		?string	$settingsname = `null`,
		bool	$requiredTag = `false`
	)

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

References __addElement().

Referenced by __handleUser().

      : void {
         foreach ($value as $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 107 of file class.ilUserXMLWriter.php.

References ilXmlWriter\xmlEndTag().

Referenced by start().

                                    : void
     {
         $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 98 of file class.ilUserXMLWriter.php.

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

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __handlePreferences()

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

private

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

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by __handleUser().

                                                                   : void // Missing array type.
     {
         //todo nadia: test mail_address_option
         $mailOptions = new ilMailOptions($row['usr_id']);
         $prefs['mail_incoming_type'] = $mailOptions->getIncomingType();
         $prefs['mail_address_option'] = $mailOptions->getEmailAddressMode();
         $prefs['mail_signature'] = $mailOptions->getSignature();
         if ($prefs !== []) {
             $this->xmlStartTag('Prefs');
             foreach ($prefs as $key => $value) {
                 if (self::isPrefExportable($key)) {
                     $this->xmlElement('Pref', ['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 ( array $row )

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

References __addElement(), __addElementMulti(), __handlePreferences(), ilObjUser\_getPreferences(), canExport(), ilDBConstants\FETCHMODE_ASSOC, ilObjUserFolder\getExportSettings(), getPictureValue(), IL_INST_ID, ILIAS\Repository\lng(), ROLE_FOLDER_ID, setSettings(), ILIAS\Repository\settings(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                             : void // Missing array type.
     {
         if ($this->settings === []) {
             $this->setSettings(ilObjUserFolder::getExportSettings());
         }
 
         $prefs = ilObjUser::_getPreferences($row['usr_id']);
 
         if ($row['language'] === null
             || $row['language'] === '') {
             $row['language'] = $this->lng->getDefaultLanguage();
         }
 
         $attrs = [
             '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->attach_roles == true) {
             $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',
                 $this->db->quote($row['usr_id'], 'integer')
             );
             $rbacresult = $this->db->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 ($type !== '') {
                     $this->xmlElement(
                         'Role',
                         ['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 ($row['auth_mode'] !== null
             && $row['auth_mode'] !== '') {
             $this->__addElement('AuthMode', null, ['type' => $row['auth_mode']], 'auth_mode', true);
         }
 
         if ($row['ext_account'] !== null
             && $row['ext_account'] !== '') {
             $this->__addElement('ExternalAccount', $row['ext_account'], null, 'ext_account', true);
         }
 
         if (isset($prefs['skin'])
             && isset($prefs['style'])
             && $this->canExport('Look', 'skin_style')) {
             $this->__addElement(
                 'Look',
                 null,
                 [
                     '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');
 
         $udf_data = new ilUserDefinedData($row['usr_id']);
         $udf_data->addToXML($this);
 
         $this->__addElement('AccountInfo', $row['ext_account'], ['Type' => 'external']);
 
         $this->__addElement('GMapsInfo', null, [
             'longitude' => $row['longitude'],
             'latitude' => $row['latitude'],
             'zoom' => $row['loc_zoom']]);
 
         $this->__addElement('Feedhash', $row['feed_hash']);
 
         if ($this->attach_preferences || $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	(	string	$tagname,
		?string	$settingsname = `null`
	)

private

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

References ILIAS\Repository\settings().

Referenced by __addElement(), and __handleUser().

      : bool {
         return $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

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

                                                      : array // Missing array type.
     {
         return [
                 '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',
                 'chat_broadcast_typing',
                 'user_tz',
                 'weekstart',
                 'mail_incoming_type',
                 'mail_signature',
                 'mail_linebreak',
                 'public_interests_general',
                 'public_interests_help_offered',
                 'public_interests_help_looking'
         ];
     }

◆ getPictureValue()

ilUserXMLWriter::getPictureValue ( int $usr_id )

private

return array with base-encoded picture data as key value, encoding type as encoding, and image type as key type.

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

Referenced by __handleUser().

                                                  : ?array
     {
         $avatar_resolver = new ilUserAvatarResolver($usr_id);
         $avatar_resolver->setForcePicture(true);
         if (!$avatar_resolver->hasProfilePicture()) {
             return null;
         }
 
         [$image_data, $image_type] = $avatar_resolver->getUserPictureForVCard();
 
         if ($image_data === null || $image_type === null) {
             return null;
         }
 
         return [
             'value' => base64_encode($image_data),
             'encoding' => 'Base64',
             'imagetype' => $image_type
         ];
     }

Here is the caller graph for this function:

◆ getXML()

ilUserXMLWriter::getXML ( )

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

◆ isPrefExportable()

static ilUserXMLWriter::isPrefExportable ( string $key )

static

returns wether a key from db is exportable or not

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

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

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

Here is the caller graph for this function:

◆ setAttachPreferences()

ilUserXMLWriter::setAttachPreferences ( bool $attach_preferences )

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

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

References $attach_preferences.

                                                                   : void
     {
         $this->attach_preferences = $attach_preferences;
     }

◆ setAttachRoles()

ilUserXMLWriter::setAttachRoles ( bool $value )

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

                                                : void
     {
         $this->attach_roles = $value;
     }

◆ setObjects()

ilUserXMLWriter::setObjects ( array $users )

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

References $users.

                                             : void // Missing array type.
     {
         $this->users = $users;
     }

◆ setSettings()

ilUserXMLWriter::setSettings ( array $settings )

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

References $settings, and ILIAS\Repository\settings().

Referenced by __handleUser().

                                                 : void // Missing array type.
     {
         $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 72 of file class.ilUserXMLWriter.php.

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

                            : bool
     {
         if (!is_array($this->users)) {
             return false;
         }
 
         $this->__buildHeader();
 
         $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

◆ $attach_preferences

bool ilUserXMLWriter::$attach_preferences = false

private

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

Referenced by setAttachPreferences().

◆ $attach_roles

bool ilUserXMLWriter::$attach_roles = false

private

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

◆ $db

ilDBInterface ilUserXMLWriter::$db

private

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

◆ $ilias

ILIAS ilUserXMLWriter::$ilias

private

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

◆ $lng

Language ilUserXMLWriter::$lng

private

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

◆ $settings

array ilUserXMLWriter::$settings = []

private

fields to be exported

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

Referenced by setSettings().

◆ $user_id

int ilUserXMLWriter::$user_id = 0

private

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

◆ $users

array ilUserXMLWriter::$users

private

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

Referenced by setObjects().

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

components/ILIAS/User/classes/class.ilUserXMLWriter.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ __addElement()

◆ __addElementMulti()

◆ __buildFooter()

◆ __buildHeader()

◆ __handlePreferences()

◆ __handleUser()

◆ canExport()

◆ getExportablePreferences()

◆ getPictureValue()

◆ getXML()

◆ isPrefExportable()

◆ setAttachPreferences()

◆ setAttachRoles()

◆ setObjects()

◆ setSettings()

◆ start()

Field Documentation

◆ $attach_preferences

◆ $attach_roles

◆ $db

◆ $ilias

◆ $lng

◆ $settings

◆ $user_id

◆ $users