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)

	setFieldsToExport (array $fields_to_export)

	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...

	addUDFsToXML (array $row)
	add user defined field data to xml (using usr dtd) More...

Private Attributes
readonly ILIAS	$ilias

readonly ilDBInterface	$db

readonly Language	$lng

readonly Profile	$user_profile

readonly SettingsImplementation	$user_settings

readonly UserSettingsDataRepository	$user_settings_data_repo

array	$users

int	$user_id = 0

bool	$attach_roles = false

bool	$attach_preferences = false

array	$fields_to_export = []
	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 39 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 320 of file class.ilUserXMLWriter.php.

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

Referenced by __addElementMulti(), and __handleUser().

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

     : void {
        foreach ($value as $item) {
            $this->__addElement($tagname, $item, $attrs, $settingsname, $requiredTag);
        }
    }

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

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

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

                                   : 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');
    }

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	(	array	$prefs,
		array	$row
	)

private

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

                                                                  : 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');
        }
    }

References 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 ( array $row )

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

                                            : void // Missing array type.
    {
        if ($this->fields_to_export === []) {
            $this->setFieldsToExport(
                array_merge(
                    $this->getExportFieldArray(
                        $this->lng,
                        $this->user_profile,
                        $this->user_settings
                    ),
                    ['time_limit_owner']
                )
            );
        }
 
        $settings = $this->user_settings_data_repo->getFor($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('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', (string) $row['time_limit_owner'], null, 'time_limit_owner');
        $this->__addElement('TimeLimitUnlimited', (string) $row['time_limit_unlimited'], null, 'time_limit_unlimited');
 
        if ($row['time_limit_from'] !== null) {
            $this->__addElement('TimeLimitFrom', (string) $row['time_limit_from'], null, 'time_limit_from');
        }
 
        if ($row['time_limit_from'] !== null) {
            $this->__addElement('TimeLimitUntil', (string) $row['time_limit_until'], null, 'time_limit_until');
        }
 
        $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($settings['skin'])
            && isset($settings['style'])
            && $this->canExport('Look', 'skin_style')) {
            $this->__addElement(
                'Look',
                null,
                [
                    'Skin' => $settings['skin'], 'Style' => $settings['style']
                ],
                'skin_style',
                true
            );
        }
 
 
        $this->__addElement('LastUpdate', $row['last_update'], null, 'last_update');
        $this->__addElement('LastLogin', $row['last_login'], null, 'last_login');
 
        $this->addUDFsToXML($row);
 
        $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($settings, $row);
        }
 
        $this->xmlEndTag('User');
    }

References __addElement(), __addElementMulti(), __handlePreferences(), addUDFsToXML(), canExport(), ilDBConstants\FETCHMODE_ASSOC, getPictureValue(), IL_INST_ID, ILIAS\Repository\lng(), ROLE_FOLDER_ID, setFieldsToExport(), 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:

◆ addUDFsToXML()

ilUserXMLWriter::addUDFsToXML ( array $row )

private

add user defined field data to xml (using usr dtd)

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

     : void {
        foreach ($this->user_profile->getVisibleFields(Context::Export) as $field) {
            if (!$field->isCustom()) {
                continue;
            }
            $this->xmlElement(
                'UserDefinedField',
                [
                    'Id' => $field->getIdentifier(),
                    'Name' => $field->getLabel($this->lng)
                ],
                json_encode($row[$field->getIdentifier()])
            );
        }
    }

Referenced by __handleUser().

Here is the caller graph for this function:

◆ canExport()

ilUserXMLWriter::canExport	(	string	$tagname,
		?string	$settingsname = `null`
	)

private

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

     : bool {
        return $this->fields_to_export === []
            || in_array(strtolower($tagname), $this->fields_to_export) !== false
            || in_array($settingsname, $this->fields_to_export) !== false;
    }

Referenced by __handleUser().

Here is the caller graph for this function:

◆ getExportablePreferences()

static ilUserXMLWriter::getExportablePreferences ( )

static

return exportable preference keys as found in db

Definition at line 406 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_avatar',
                '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 361 of file class.ilUserXMLWriter.php.

                                                 : ?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
        ];
    }

Referenced by __handleUser().

Here is the caller graph for this function:

◆ getXML()

ilUserXMLWriter::getXML ( )

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

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

References ilXmlWriter\xmlDumpMem().

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

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

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

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

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

◆ setAttachRoles()

ilUserXMLWriter::setAttachRoles ( bool $value )

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

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

◆ setFieldsToExport()

ilUserXMLWriter::setFieldsToExport ( array $fields_to_export )

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

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

Referenced by __handleUser().

Here is the caller graph for this function:

◆ setObjects()

ilUserXMLWriter::setObjects ( array $users )

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

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

References $users.

◆ start()

ilUserXMLWriter::start ( )

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

                           : bool
    {
        if (!is_array($this->users)) {
            return false;
        }
 
        $this->__buildHeader();
 
        foreach ($this->users as $user) {
            $this->__handleUser($user);
        }
 
        $this->__buildFooter();
 
        return true;
    }

References __buildFooter(), __buildHeader(), and __handleUser().

Here is the call graph for this function:

Field Documentation

◆ $attach_preferences

bool ilUserXMLWriter::$attach_preferences = false

private

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

◆ $attach_roles

bool ilUserXMLWriter::$attach_roles = false

private

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

◆ $db

readonly ilDBInterface ilUserXMLWriter::$db

private

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

◆ $fields_to_export

array ilUserXMLWriter::$fields_to_export = []

private

fields to be exported

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

◆ $ilias

readonly ILIAS ilUserXMLWriter::$ilias

private

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

◆ $lng

readonly Language ilUserXMLWriter::$lng

private

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

◆ $user_id

int ilUserXMLWriter::$user_id = 0

private

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

◆ $user_profile

readonly Profile ilUserXMLWriter::$user_profile

private

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

◆ $user_settings

readonly SettingsImplementation ilUserXMLWriter::$user_settings

private

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

◆ $user_settings_data_repo

readonly UserSettingsDataRepository ilUserXMLWriter::$user_settings_data_repo

private

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

◆ $users

array ilUserXMLWriter::$users

private

Definition at line 49 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()

◆ addUDFsToXML()

◆ canExport()

◆ getExportablePreferences()

◆ getPictureValue()

◆ getXML()

◆ isPrefExportable()

◆ setAttachPreferences()

◆ setAttachRoles()

◆ setFieldsToExport()

◆ setObjects()

◆ start()

Field Documentation

◆ $attach_preferences

◆ $attach_roles

◆ $db

◆ $fields_to_export

◆ $ilias

◆ $lng

◆ $user_id

◆ $user_profile

◆ $user_settings

◆ $user_settings_data_repo

◆ $users