Inheritance diagram for ilUserDataSet:

Collaboration diagram for ilUserDataSet:

Public Member Functions
	__construct ()

	getSupportedVersions ()

	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

Public Member Functions inherited from ilDataSet
	__construct ()

	init (string $a_entity, string $a_schema_version)
	Init. More...

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

	initByExporter (ilXmlExporter $xml_exporter)

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setDSPrefix (string $a_val)

	getDSPrefix ()

	getDSPrefixString ()

	getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper (string $a_str)
	Make xyz_abc a XyzAbc string. More...

	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $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 (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)

	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...

	getXmlTypes (string $a_entity, string $a_version)
	Get xml types. More...

	getXMLEntityName (string $a_entity, string $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag (string $a_entity, string $a_schema_version)
	Get entity tag. More...

	setImport (ilSurveyImporter $a_val)

	getImport ()

	setCurrentInstallationId (string $a_val)

	getCurrentInstallationId ()

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

	getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)

Data Fields
array	$multi = []

Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

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

int	$dircnt = 0

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)

	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...

Protected Member Functions inherited from ilDataSet
	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace (string $a_entity, string $a_schema_version)

	getExportDirInContainer (string $exp_dir)

	getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

	createObjectExportId (string $a_type, string $a_id)
	Build ilias export id. More...

	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...

	stripTags (array $rec, array $omit_keys=[])

Protected Attributes
ilUserExportConfig	$export_config

array	$temp_picture_dirs = []

array	$users

Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss

string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$component_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

ilExport	$export

Private Member Functions
	buildProfileFieldArrayKeyFromIdentifier (string $identifier)

	retrieveValueFromImportArray (array $import_array, string $key)

	buildFileUploadDir (string $rel_path, string $usr_id)

Private Attributes
Profile	$user_profile

ilObjUser	$current_user

Detailed Description

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 31 of file class.ilUserDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserDataSet::__construct ( )

Reimplemented from ilDataSet.

Definition at line 40 of file class.ilUserDataSet.php.

    {
        global $DIC;
        $this->current_user = $DIC['ilUser'];
 
        parent::__construct();
 
        $this->user_profile = LocalDIC::dic()[Profile::class];
    }

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ afterXmlRecordWriting()

ilUserDataSet::afterXmlRecordWriting	(	string	$a_entity,
		string	$a_version,
		array	$a_set
	)

Reimplemented from ilDataSet.

Definition at line 178 of file class.ilUserDataSet.php.

                                                                                            : void // Missing array type.
    {
        if ($a_entity == "usr_profile") {
            // cleanup temp dirs for pictures
            $tmp_dir = $this->temp_picture_dirs[$a_set["Id"]];
            if ($tmp_dir != "" && is_dir($tmp_dir)) {
                ilFileUtils::delDir($tmp_dir);
            }
        }
    }

References ilFileUtils\delDir().

Here is the call graph for this function:

◆ buildFileUploadDir()

ilUserDataSet::buildFileUploadDir	(	string	$rel_path,
		string	$usr_id
	)

private

Definition at line 401 of file class.ilUserDataSet.php.

     : string {
        $pic_dir = "{$this->getImportDirectory()}/"
            . str_replace('..', '', $rel_path);
        if ($pic_dir === '' || !is_dir($pic_dir)) {
            return '';
        }
 
        $upload_file = "{$pic_dir}/usr_{$usr_id}.jpg";
        if (!is_file($upload_file)) {
            return '';
        }
 
        return $upload_file;
    }

◆ buildProfileFieldArrayKeyFromIdentifier()

ilUserDataSet::buildProfileFieldArrayKeyFromIdentifier ( string $identifier )

private

Definition at line 368 of file class.ilUserDataSet.php.

     : string {
        return $this->convertToLeadingUpper(
            match ($identifier) {
                'avatar' => 'picture',
                'location' => 'latitude',
                default => $identifier
            }
        );
    }

Referenced by importRecord().

Here is the caller graph for this function:

◆ getSupportedVersions()

ilUserDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

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

                                          : array // Missing array type.
    {
        return ["4.3.0", "4.5.0", "5.1.0", "5.2.0", "5.3.0"];
    }

◆ getTypes()

ilUserDataSet::getTypes	(	string	$a_entity,
		string	$a_version
	)

protected

Get (abstract) types for (abstract) field names.

Please note that the abstract fields/types only depend on the version! Not on a choosen representation!

Returns: array types array, e.g. array("field_1" => "text", "field_2" => "integer", ...)

Reimplemented from ilDataSet.

Definition at line 68 of file class.ilUserDataSet.php.

                                                                    : array // Missing array type.
    {
        // user profile type
        if ($a_entity == "usr_profile") {
            switch ($a_version) {
                case "4.3.0":
                case "4.5.0":
                case "5.1.0":
                case "5.2.0":
                case "5.3.0":
                    return [
                        "Id" => "integer",
                        "Username" => "text",
                        "Firstname" => "text",
                        "Lastname" => "text",
                        "Title" => "text",
                        "Birthday" => "text",
                        "Gender" => "text",
                        "Institution" => "text",
                        "Department" => "text",
                        "Street" => "text",
                        "Zipcode" => "text",
                        "City" => "text",
                        "Country" => "text",
                        "PhoneOffice" => "text",
                        "PhoneHome" => "text",
                        "PhoneMobile" => "text",
                        "Fax" => "text",
                        "Email" => "text",
                        "SecondEmail" => "text",
                        "Hobby" => "text",
                        "ReferralComment" => "text",
                        "Matriculation" => "text",
                        "Latitude" => "text",
                        "Longitude" => "text",
                        "LocZoom" => "text",
                        "Picture" => "directory"
                        ];
            }
        }
 
        if ($a_entity == "usr_setting") {
            switch ($a_version) {
                case "4.3.0":
                case "4.5.0":
                case "5.1.0":
                case "5.2.0":
                case "5.3.0":
                    return [
                        "UserId" => "integer",
                        "Keyword" => "text",
                        "Value" => "text"
                    ];
            }
        }
 
        if ($this->export_config->getExportType() == "personal_data") {
            switch ($a_version) {
                case "4.3.0":
                case "4.5.0":
                case "5.1.0":
                case "5.2.0":
                case "5.3.0":
                    return [
                        "Id" => "integer"
                    ];
            }
        }
 
        if ($a_entity == "usr_multi") {
            switch ($a_version) {
                case "4.5.0":
                case "5.1.0":
                case "5.2.0":
                case "5.3.0":
                    return [
                        "UserId" => "integer",
                        "FieldId" => "text",
                        "Value" => "text"
                    ];
            }
        }
        return [];
    }

◆ getXmlNamespace()

ilUserDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

protected

Reimplemented from ilDataSet.

Definition at line 63 of file class.ilUserDataSet.php.

                                                                                  : string
    {
        return "https://www.ilias.de/xml/Services/User/" . $a_entity;
    }

◆ getXmlRecord()

ilUserDataSet::getXmlRecord	(	string	$a_entity,
		string	$a_version,
		array	$a_set
	)

Get xml record for version.

Parameters

array $a_set abstract data record

Reimplemented from ilDataSet.

Definition at line 153 of file class.ilUserDataSet.php.

                                                                                   : array // Missing array type.
    {
        if ($a_entity == "usr_profile") {
            $tmp_dir = ilFileUtils::ilTempnam();
            ilFileUtils::makeDir($tmp_dir);
 
            $im = ilObjUser::_getPersonalPicturePath(
                $a_set["Id"],
                "small",
                true,
                true
            );
 
            if ($im != "") {
                ilObjUser::copyProfilePicturesToDirectory($a_set["Id"], $tmp_dir);
            }
 
            $this->temp_picture_dirs[$a_set["Id"]] = $tmp_dir;
 
            $a_set["Picture"] = $tmp_dir;
        }
 
        return $a_set;
    }

References ilObjUser\_getPersonalPicturePath(), ilObjUser\copyProfilePicturesToDirectory(), ilFileUtils\ilTempnam(), and ilFileUtils\makeDir().

Here is the call graph for this function:

◆ importRecord()

ilUserDataSet::importRecord	(	string	$a_entity,
		array	$a_types,
		array	$a_rec,
		ilImportMapping	$a_mapping,
		string	$a_schema_version
	)

Needs to be overwritten for import use case.

Reimplemented from ilDataSet.

Definition at line 299 of file class.ilUserDataSet.php.

     : void {
        switch ($a_entity) {
            case "usr":
                // only users themselves import their profiles!
                // thus we can map the import id of the dataset to the current user
                $a_mapping->addMapping(
                    'components/ILIAS/User',
                    'usr',
                    $a_rec['Id'],
                    (string) $this->current_user->getId()
                );
                break;
 
            case "usr_profile":
                $usr_id = (int) $a_mapping->getMapping("components/ILIAS/User", "usr", $a_rec["Id"]);
                if ($usr_id > 0 && ilObject::_lookupType($usr_id) == "usr") {
                    if (!isset($this->users[$usr_id])) {
                        $this->users[$usr_id] = new ilObjUser($usr_id);
                    }
                    $user = array_reduce(
                        $this->user_profile->getFields([], [Alias::class, Roles::class]),
                        function (\ilObjUser $c, ProfileField $v) use ($a_rec): \ilObjUser {
                            $array_key = $this->buildProfileFieldArrayKeyFromIdentifier($v->getIdentifier());
                            if (!$this->user_profile->userFieldEditableByUser($v->getIdentifier())
                                || !isset($a_rec[$array_key])) {
                                return $c;
                            }
                            return $v->addValueToUserObject(
                                $c,
                                Context::UserAdministration,
                                $this->retrieveValueFromImportArray(
                                    $a_rec,
                                    $array_key
                                )
                            );
                        },
                        $this->users[$usr_id]
                    );
 
                    $user->update();
                }
                break;
 
            case "usr_setting":
                $usr_id = (int) $a_mapping->getMapping("components/ILIAS/User", "usr", $a_rec["UserId"]);
                if ($usr_id > 0 && ilObject::_lookupType($usr_id) === "usr") {
                    if (!isset($this->users[$usr_id])) {
                        $this->users[$usr_id] = new ilObjUser($usr_id);
                    }
                    $user = $this->users[$usr_id];
                    $user->writePref($a_rec["Keyword"], ilUtil::secureString($a_rec["Value"]));
                }
                break;
 
            case "usr_multi":
                $usr_id = (int) $a_mapping->getMapping("components/ILIAS/User", "usr", $a_rec["UserId"]);
                if ($usr_id > 0 && ilObject::_lookupType($usr_id) === "usr") {
                    $this->multi[$usr_id][$a_rec["FieldId"]][] = ilUtil::secureString($a_rec["Value"]);
                }
                break;
        }
    }

References $c, ilObject\_lookupType(), ilImportMapping\addMapping(), buildProfileFieldArrayKeyFromIdentifier(), ilImportMapping\getMapping(), ILIAS\Repository\int(), retrieveValueFromImportArray(), and ilUtil\secureString().

Here is the call graph for this function:

◆ readData()

ilUserDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

Read data from DB.

This should result in the abstract field structure of the version set in the constructor.

Reimplemented from ilDataSet.

Definition at line 189 of file class.ilUserDataSet.php.

                                                                               : void // Missing array type.
    {
        if (!is_array($a_ids)) {
            $a_ids = [$a_ids];
        }
 
        if ($this->export_config->getExportType() == "personal_data") {
            switch ($a_version) {
                case "4.3.0":
                case "4.5.0":
                case "5.1.0":
                case "5.2.0":
                case "5.3.0":
                    $this->data = [];
                    foreach ($a_ids as $id) {
                        $this->data[] = ["Id" => $id];
                    }
                    break;
            }
        }
 
        if ($a_entity == "usr_profile") {
            switch ($a_version) {
                case "4.3.0":
                case "4.5.0":
                case "5.1.0":
                    $this->getDirectDataFromQuery("SELECT usr_id id, login username, firstname, lastname, " .
                        " title, birthday, gender, institution, department, street, city, zipcode, country, " .
                        " phone_office, phone_home, phone_mobile, fax, email, hobby, referral_comment, matriculation, " .
                        " delicious, latitude, longitude, loc_zoom" .
                        " FROM usr_data u " .
                        "WHERE " .
                        $this->db->in("u.usr_id", $a_ids, false, "integer"));
                    break;
 
                case "5.2.0":
                    $this->getDirectDataFromQuery("SELECT usr_id id, login username, firstname, lastname, " .
                        " title, birthday, gender, institution, department, street, city, zipcode, country, " .
                        " phone_office, phone_home, phone_mobile, fax, email, hobby, referral_comment, matriculation, " .
                        " latitude, longitude, loc_zoom" .
                        " FROM usr_data u " .
                        "WHERE " .
                        $this->db->in("u.usr_id", $a_ids, false, "integer"));
                    break;
                case "5.3.0":
                    $this->getDirectDataFromQuery("SELECT usr_id id, login username, firstname, lastname, " .
                        " title, birthday, gender, institution, department, street, city, zipcode, country, " .
                        " phone_office, phone_home, phone_mobile, fax, email, second_email, hobby, referral_comment, matriculation, " .
                        " latitude, longitude, loc_zoom" .
                        " FROM usr_data u " .
                        "WHERE " .
                        $this->db->in("u.usr_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "usr_setting") {
            switch ($a_version) {
                case "4.3.0":
                case "4.5.0":
                case "5.1.0":
                case "5.2.0":
                case "5.3.0":
                    // for all user ids get data from usr_pref and mail options, create records user_id/name/value
                    $prefs = ["date_format", "day_end", "day_start", "bs_allow_to_contact_me", "chat_osc_accept_msg", "hide_own_online_status", "language",
                        "public_birthday", "puplic_city", "public_country", "public_delicious", "public_department", "public_email", "public_second_email",
                        "public_fax", "public_gender", "public_hobby", "public_institution", "public_location",
                        "public_matriculation", "public_phone_home", "public_phone_mobile", "public_phone_office",
                        "public_profile", "public_country", "public_street", "public_title", "public_avatar", "public_zipcode",
                        "screen_reader_optimization", "show_users_online",
                        "store_last_visited", "time_format", "user_tz", "weekstart",
                        "session_reminder_lead_time", "usr_starting_point", "usr_starting_point_ref_id",
                        "chat_broadcast_typing"];
 
                    if (version_compare($a_version, '5.2.0', '>=')) {
                        unset(
                            $prefs['public_im_aim'], $prefs['public_im_icq'], $prefs['public_im_jabber'],
                            $prefs['public_im_msn'], $prefs['public_im_skype'], $prefs['public_im_voip'],
                            $prefs['public_im_yahoo'], $prefs['public_delicious']
                        );
                    }
 
                    $this->data = [];
                    $set = $this->db->query("SELECT * FROM usr_pref " .
                        " WHERE " . $this->db->in("keyword", $prefs, false, "text") .
                        " AND " . $this->db->in("usr_id", $a_ids, false, "integer"));
                    while ($rec = $this->db->fetchAssoc($set)) {
                        $this->data[] = ["UserId" => $rec["usr_id"], "Keyword" => $rec["keyword"], "Value" => $rec["value"]];
                    }
                    break;
            }
        }
 
        if ($a_entity == "usr_multi") {
            switch ($a_version) {
                case "4.5.0":
                case "5.1.0":
                case "5.2.0":
                case "5.3.0":
                    $this->data = [];
                    $set = $this->db->query("SELECT * FROM usr_profile_data" .
                        " WHERE " . $this->db->in("usr_id", $a_ids, false, "integer"));
                    while ($rec = $this->db->fetchAssoc($set)) {
                        $this->data[] = ["UserId" => $rec["usr_id"], "FieldId" => $rec["field_id"], "Value" => $rec["value"]];
                    }
                    break;
            }
        }
    }

References $id, and ilDataSet\getDirectDataFromQuery().

Here is the call graph for this function:

◆ retrieveValueFromImportArray()

ilUserDataSet::retrieveValueFromImportArray	(	array	$import_array,
		string	$key
	)

private

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

     : mixed {
        return match($key) {
            'Latitude' => [
                'latitude' => $import_array['Latitude'],
                'longitude' => $import_array['Longitude'],
                'zoom' => (int) $import_array['LocZoom']
            ],
            'Picture' => [
                'tmp_name' => $this->buildFileUploadDir(
                    $import_array[$key],
                    $import_array['Id']
                ),
                'alias' => $import_array['Username']
            ],
            default => ilUtil::secureString($import_array[$key])
        };
    }

References ILIAS\Repository\int(), and ilUtil\secureString().

Referenced by importRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $current_user

ilObjUser ilUserDataSet::$current_user

private

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

◆ $export_config

ilUserExportConfig ilUserDataSet::$export_config

protected

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

◆ $multi

array ilUserDataSet::$multi = []

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

◆ $temp_picture_dirs

array ilUserDataSet::$temp_picture_dirs = []

protected

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

◆ $user_profile

Profile ilUserDataSet::$user_profile

private

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

◆ $users

array ilUserDataSet::$users

protected

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

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ afterXmlRecordWriting()

◆ buildFileUploadDir()

◆ buildProfileFieldArrayKeyFromIdentifier()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ importRecord()

◆ readData()

◆ retrieveValueFromImportArray()

Field Documentation

◆ $current_user

◆ $export_config

◆ $multi

◆ $temp_picture_dirs

◆ $user_profile

◆ $users