ilUserDataSet Class Reference

Exercise data set class. More...

Inheritance diagram for ilUserDataSet:

Collaboration diagram for ilUserDataSet:

Public Member Functions
	getSupportedVersions ()
	Get supported versions. More...
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record. More...
	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...
	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...
	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. More...
Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor. More...
	init ($a_entity, $a_schema_version)
	Init. More...
	getSupportedVersions ()
	Get supported version. More...
	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...
	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...
	setImportDirectory ($a_val)
	Set import directory. More...
	getImportDirectory ()
	Get import directory. More...
	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...
	getDSPrefix ()
	Get XML dataset namespace prefix. More...
	getDSPrefixString ()
	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...
	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...
	getJsonRepresentation ()
	Get json representation. More...
	getXmlRepresentation ( $a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $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 ...> ... More...
	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...
	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...
	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...
	getJsonRecord ($a_set)
	Get json record for version. More...
	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...
	getJsonTypes ($a_entity, $a_version)
	Get json types. More...
	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...
	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...
	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...
	setImport ($a_val)
	Set import object. More...
	getImport ()
	Get import object. More...
	setCurrentInstallationId ($a_val)
	Set current installation id. More...
	getCurrentInstallationId ()
	Get current installation id. More...

Data Fields
	$multi = array()
Data Fields inherited from ilDataSet
	$dircnt
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

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity. More...
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. More...
Protected Member Functions inherited from ilDataSet
	getTypes ($a_entity, $a_version)
	Get (abstract) types for (abstract) field names. More...
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...
	createObjectExportId ($a_type, $a_id)
	Build ilias export id. More...
	parseObjectExportId ($a_id, $a_fallback_id=null)
	Parse export id. More...

Protected Attributes
	$temp_picture_dirs = array()
Protected Attributes inherited from ilDataSet
	$current_installation_id = ""
	$db
	$ds_log

Detailed Description

Exercise data set class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Member Function Documentation

afterXmlRecordWriting()

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

After xml record writing hook record.

Parameters

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

References ilUtil\delDir().

    {
        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)) {
                ilUtil::delDir($tmp_dir);
            }
        }
    }

Here is the call graph for this function:

getDependencies()

ilUserDataSet::getDependencies (   $a_entity,   $a_version,   $a_rec,   $a_ids  )

protected

Determine the dependent sets of data.

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

    {
        return false;
        switch ($a_entity) {
            case "personal_data":
                return array(
                    "usr_profile" => array("ids" => $a_rec["Id"]),
                    "usr_setting" => array("ids" => $a_rec["Id"]),
                    "usr_multi" => array("ids" => $a_rec["Id"])
                );
        }
        return false;
    }

getSupportedVersions()

ilUserDataSet::getSupportedVersions

(

)

Get supported versions.

Parameters

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

    {
        return array("4.3.0", "4.5.0", "5.1.0", "5.2.0", "5.3.0");
    }

getTypes()

ilUserDataSet::getTypes (   $a_entity,   $a_version  )

protected

Get field types for entity.

Parameters

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

    {
        // 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 array(
                        "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",
                        "SelCountry" => "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 array(
                        "UserId" => "integer",
                        "Keyword" => "text",
                        "Value" => "text"
                    );
            }
        }

        if ($a_entity == "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 array(
                        "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 array(
                        "UserId" => "integer",
                        "FieldId" => "text",
                        "Value" => "text"
                    );
            }
        }
    }

getXmlNamespace()

ilUserDataSet::getXmlNamespace	(		$a_entity,
			$a_schema_version
	)

Get xml namespace.

Parameters

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

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

getXmlRecord()

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

Get xml record.

Parameters

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

References $DIC, $ilLog, ilObjUser\copyProfilePicturesToDirectory(), ilUtil\ilTempnam(), and ilUtil\makeDir().

    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        if ($a_entity == "usr_profile") {
            $tmp_dir = ilUtil::ilTempnam();
            ilUtil::makeDir($tmp_dir);
            include_once("./Services/User/classes/class.ilObjUser.php");

            $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;
    }

Here is the call graph for this function:

importRecord()

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

Import record.

Parameters

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

References $DIC, $f, $ilSetting, $ilUser, $user, ilObject\_lookupType(), ilObjUser\_uploadPersonalPicture(), ilDataSet\convertToLeadingUpper(), ilDataSet\getImportDirectory(), ilUtil\secureString(), and ilUserProfile\userSettingVisible().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        $ilUser = $DIC['ilUser'];
        //echo $a_entity;
        //var_dump($a_rec);

        switch ($a_entity) {
            case "personal_data":
                // only users themselves import their profiles!
                // thus we can map the import id of the dataset to the current user
                $a_mapping->addMapping("Services/User", "usr", $a_rec["Id"], $ilUser->getId());
                break;
                
            case "usr_profile":
                $usr_id = $a_mapping->getMapping("Services/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 = $this->users[$usr_id];
                    include_once("./Services/User/classes/class.ilUserProfile.php");
                    $prof = new ilUserProfile();
                    $prof->skipField("username");
                    $prof->skipField("password");
                    $prof->skipField("roles");
                    $prof->skipGroup("settings");
                    $fields = $prof->getStandardFields();
                    foreach ($fields as $k => $f) {
                        $up_k = $this->convertToLeadingUpper($k);
                        // only change fields, when it is possible in profile
                        if (ilUserProfile::userSettingVisible($k) &&
                            !$ilSetting->get("usr_settings_disable_" . $k) &&
                            $f["method"] != "" && isset($a_rec[$up_k])) {
                            $set_method = "set" . substr($f["method"], 3);
                            $user->{$set_method}(ilUtil::secureString($a_rec[$up_k]));
                        }
                    }

                    $user->setLatitude($a_rec["Latitude"]);
                    $user->setLongitude($a_rec["Longitude"]);
                    $user->setLocationZoom($a_rec["LocZoom"]);

                    $user->update();
                    
                    // personal picture
                    $pic_dir = $this->getImportDirectory() . "/" . str_replace("..", "", $a_rec["Picture"]);
                    if ($pic_dir != "" && is_dir($pic_dir)) {
                        $upload_file = $pic_dir . "/upload_" . $a_rec["Id"] . "pic";
                        if (is_file($upload_file)) {
                            ilObjUser::_uploadPersonalPicture($upload_file, $user->getId());
                        }
                    }
                }
                break;

            case "usr_setting":
                $usr_id = $a_mapping->getMapping("Services/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 = $a_mapping->getMapping("Services/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;
        }
    }

Here is the call graph for this function:

readData()

ilUserDataSet::readData	(		$a_entity,
			$a_version,
			$a_ids,
			$a_field = ""
	)

Read data.

Parameters

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

References $DIC, $id, $ilDB, data, and ilDataSet\getDirectDataFromQuery().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
                
        if ($a_entity == "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 = array();
                    foreach ($a_ids as $id) {
                        $this->data[] = array("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, sel_country, " .
                        " phone_office, phone_home, phone_mobile, fax, email, hobby, referral_comment, matriculation, " .
                        " delicious, latitude, longitude, loc_zoom" .
                        " FROM usr_data u " .
                        "WHERE " .
                        $ilDB->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, sel_country, " .
                        " phone_office, phone_home, phone_mobile, fax, email, hobby, referral_comment, matriculation, " .
                        " latitude, longitude, loc_zoom" .
                        " FROM usr_data u " .
                        "WHERE " .
                        $ilDB->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, sel_country, " .
                        " phone_office, phone_home, phone_mobile, fax, email, second_email, hobby, referral_comment, matriculation, " .
                        " latitude, longitude, loc_zoom" .
                        " FROM usr_data u " .
                        "WHERE " .
                        $ilDB->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 = array("date_format", "day_end", "day_start", "bs_allow_to_contact_me", "chat_osc_accept_msg", "hide_own_online_status", "hits_per_page", "language",
                        "public_birthday", "puplic_city", "public_country", "public_delicious", "public_department", "public_email", "public_second_email",
                        "public_fax", "public_gender", "public_hobby", "public_im_aim", "public_im_icq", "public_im_jabber",
                        "public_im_msn", "public_im_skype", "public_im_voip", "public_im_yahoo", "public_institution", "public_location",
                        "public_matriculation", "public_phone_home", "public_phone_mobile", "public_phone_office",
                        "public_profile", "public_sel_country", "public_street", "public_title", "public_upload", "public_zipcode",
                        "screen_reader_optimization", "show_users_online",
                        "store_last_visited", "time_format", "user_tz", "weekstart",
                        "session_reminder_enabled", "session_reminder_lead_time", "usr_starting_point",
                        "char_selector_availability", "char_selector_definition");

                    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 = array();
                    $set = $ilDB->query("SELECT * FROM usr_pref " .
                        " WHERE " . $ilDB->in("keyword", $prefs, false, "text") .
                        " AND " . $ilDB->in("usr_id", $a_ids, false, "integer"));
                    while ($rec = $ilDB->fetchAssoc($set)) {
                        $this->data[] = array("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 = array();
                    $set = $ilDB->query("SELECT * FROM usr_data_multi" .
                        " WHERE " . $ilDB->in("usr_id", $a_ids, false, "integer"));
                    while ($rec = $ilDB->fetchAssoc($set)) {
                        $this->data[] = array("UserId" => $rec["usr_id"], "FieldId" => $rec["field_id"], "Value" => $rec["value"]);
                    }
                    break;
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$multi

ilUserDataSet::$multi = array()

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

$temp_picture_dirs

ilUserDataSet::$temp_picture_dirs = array()

protected

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

---

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

• Services/User/classes/class.ilUserDataSet.php