ilUserDefinedData Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilUserDefinedData:

Public Member Functions
	__construct (int $a_usr_id)
	getUserId ()
	set (string $a_field, string $a_value)
	get (string $a_field)
	getAll ()
	update ()
	toXML ()
	addToXML (ilXmlWriter $xml_writer)
	add user defined field data to xml (using usr dtd) More...
	__read ()

Static Public Member Functions
static	lookupData (array $a_user_ids, array $a_field_ids)
	Lookup data. More...
static	deleteEntriesOfUser (int $a_user_id)
static	deleteEntriesOfField (int $a_field_id)
	Delete data of particular field. More...
static	deleteFieldValue (int $a_field_id, string $a_value)
	Delete data of particular value of a (selection) field. More...

Data Fields
ilDBInterface	$db = null
array	$user_data = []
int	$usr_id = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilUserDefinedData

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 23 of file class.ilUserDefinedData.php.

Constructor & Destructor Documentation

__construct()

ilUserDefinedData::__construct

(

int

$a_usr_id

)

Definition at line 29 of file class.ilUserDefinedData.php.

References $DIC, $ilDB, and __read().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->db = $ilDB;
        $this->usr_id = $a_usr_id;

        $this->__read();
    }

Here is the call graph for this function:

Member Function Documentation

__read()

ilUserDefinedData::__read

(

)

Definition at line 213 of file class.ilUserDefinedData.php.

References $res, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by __construct().

                            : void
    {
        $this->user_data = [];
        $query = "SELECT * FROM udf_text " .
            "WHERE usr_id = " . $this->db->quote($this->usr_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->user_data["f_" . $row["field_id"]] = $row["value"];
        }
        $query = "SELECT * FROM udf_clob " .
            "WHERE usr_id = " . $this->db->quote($this->usr_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->user_data["f_" . $row["field_id"]] = $row["value"];
        }
    }

Here is the caller graph for this function:

addToXML()

ilUserDefinedData::addToXML

(

ilXmlWriter

$xml_writer

)

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

Definition at line 196 of file class.ilUserDefinedData.php.

References ilUserDefinedFields\_getInstance(), and ilXmlWriter\xmlElement().

Referenced by toXML().

                                                     : void
    {
        $udf_obj = ilUserDefinedFields::_getInstance();

        foreach ($udf_obj->getDefinitions() as $definition) {
            if ($definition["export"] != false) {
                $xml_writer->xmlElement(
                    'UserDefinedField',
                    ['Id' => $definition['il_id'],
                                          'Name' => $definition['field_name']],
                    (string) ($this->user_data['f_' . (int) $definition['field_id']] ?? '')
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteEntriesOfField()

static ilUserDefinedData::deleteEntriesOfField ( int  $a_field_id )

static

Delete data of particular field.

Definition at line 150 of file class.ilUserDefinedData.php.

References $DIC, and $ilDB.

Referenced by ilUserDefinedFields\delete().

                                                                : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ilDB->manipulate(
            "DELETE FROM udf_text WHERE "
            . " field_id = " . $ilDB->quote($a_field_id, "integer")
        );
        $ilDB->manipulate(
            "DELETE FROM udf_clob WHERE "
            . " field_id = " . $ilDB->quote($a_field_id, "integer")
        );
    }

Here is the caller graph for this function:

deleteEntriesOfUser()

static ilUserDefinedData::deleteEntriesOfUser ( int  $a_user_id )

static

Definition at line 131 of file class.ilUserDefinedData.php.

References $DIC, and $ilDB.

Referenced by ilObjUser\deleteUserDefinedFieldEntries().

                                                              : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ilDB->manipulate(
            "DELETE FROM udf_text WHERE "
            . " usr_id = " . $ilDB->quote($a_user_id, "integer")
        );
        $ilDB->manipulate(
            "DELETE FROM udf_clob WHERE "
            . " usr_id = " . $ilDB->quote($a_user_id, "integer")
        );
    }

Here is the caller graph for this function:

deleteFieldValue()

static ilUserDefinedData::deleteFieldValue ( int  $a_field_id, string  $a_value  )

static

Delete data of particular value of a (selection) field.

Definition at line 169 of file class.ilUserDefinedData.php.

References $DIC, and $ilDB.

Referenced by ilUserDefinedFields\deleteValue(), and ilCustomUserFieldsGUI\update().

     : void {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ilDB->manipulate(
            "UPDATE udf_text SET value = " . $ilDB->quote("", "text") . " WHERE "
            . " field_id = " . $ilDB->quote($a_field_id, "integer")
            . " AND value = " . $ilDB->quote($a_value, "text")
        );
    }

Here is the caller graph for this function:

get()

ilUserDefinedData::get

(

string

$a_field

)

Definition at line 82 of file class.ilUserDefinedData.php.

Referenced by ilMemberExport\addUserDefinedField().

                                        : string
    {
        return $this->user_data[$a_field] ?? '';
    }

Here is the caller graph for this function:

getAll()

ilUserDefinedData::getAll

(

)

Returns

array<string, string>

Definition at line 90 of file class.ilUserDefinedData.php.

                            : array
    {
        return array_map(
            static fn($value): string => $value ?? '',
            $this->user_data
        );
    }

getUserId()

ilUserDefinedData::getUserId

(

)

Definition at line 72 of file class.ilUserDefinedData.php.

References $usr_id.

Referenced by ilMemberExport\addUserDefinedField(), and update().

                               : int
    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

lookupData()

static ilUserDefinedData::lookupData ( array  $a_user_ids, array  $a_field_ids  )

static

Lookup data.

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

References $DIC, $ilDB, XapiProxy\$plugin, $res, $user_id, ilDBConstants\FETCHMODE_ASSOC, and ilCustomUserFieldsHelper\getInstance().

Referenced by ilGroupParticipantsTableGUI\parse(), ilLearningSequenceParticipantsTableGUI\parse(), ilCourseParticipantsTableGUI\parse(), ilRepositoryUserResultTableGUI\parseUserIds(), ilSubscriberTableGUI\readSubscriberData(), and ilWaitingListTableGUI\readUserData().

                                                                            : array // Missing array type.
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM udf_text " .
            "WHERE " . $ilDB->in('usr_id', $a_user_ids, false, 'integer') . ' ' .
            'AND ' . $ilDB->in('field_id', $a_field_ids, false, 'integer');
        $res = $ilDB->query($query);

        $udfd = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $udfd[$row['usr_id']][$row['field_id']] = $row['value'];
        }

        $def_helper = ilCustomUserFieldsHelper::getInstance();
        foreach ($def_helper->getActivePlugins() as $plugin) {
            foreach ($plugin->lookupUserData($a_user_ids, $a_field_ids) as $user_id => $usr_data) {
                foreach ($usr_data as $field_id => $value) {
                    $udfd[$user_id][$field_id] = $value;
                }
            }
        }

        return $udfd;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

set()

ilUserDefinedData::set	(	string	$a_field,
		string	$a_value
	)

Definition at line 77 of file class.ilUserDefinedData.php.

Referenced by ilUserImportParser\importEndTag().

                                                         : void
    {
        $this->user_data[$a_field] = $a_value;
    }

Here is the caller graph for this function:

toXML()

ilUserDefinedData::toXML

(

)

Definition at line 184 of file class.ilUserDefinedData.php.

References addToXML().

                           : string
    {
        $xml_writer = new ilXmlWriter();

        $this->addToXML($xml_writer);

        return $xml_writer->xmlDumpMem(false);
    }

Here is the call graph for this function:

update()

ilUserDefinedData::update

(

)

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

References $DIC, $ilDB, ilUserDefinedFields\_getInstance(), getUserId(), and UDF_TYPE_WYSIWYG.

                            : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $udf_obj = ilUserDefinedFields::_getInstance();

        foreach ($udf_obj->getDefinitions() as $definition) {
            if ($definition["field_type"] == UDF_TYPE_WYSIWYG) {
                $ilDB->replace(
                    "udf_clob",
                    [
                        "usr_id" => ["integer", $this->getUserId()],
                        "field_id" => ["integer", $definition['field_id']]],
                    [
                        "value" => ["clob", $this->get("f_" . $definition['field_id'])]
                        ]
                );
            } else {
                $ilDB->replace(
                    "udf_text",
                    [
                        "usr_id" => ["integer", $this->getUserId()],
                        "field_id" => ["integer", $definition['field_id']]],
                    [
                        "value" => ["text", $this->get("f_" . $definition['field_id'])]
                        ]
                );
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilUserDefinedData::$db = null

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

$user_data

array ilUserDefinedData::$user_data = []

Definition at line 26 of file class.ilUserDefinedData.php.

$usr_id

int ilUserDefinedData::$usr_id = null

Definition at line 27 of file class.ilUserDefinedData.php.

Referenced by getUserId().

---

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

• components/ILIAS/User/classes/class.ilUserDefinedData.php