ilUserDefinedData Class Reference

Class ilUserDefinedData. More...

Collaboration diagram for ilUserDefinedData:

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

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

Data Fields
	$db = null
	$user_data = array()
	$usr_id = null

Detailed Description

Class ilUserDefinedData.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilUserDefinedData::__construct

(

$a_usr_id

)

Definition at line 18 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 241 of file class.ilUserDefinedData.php.

References $query, $res, $row, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by __construct().

    {
        $this->user_data = array();
        $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

(

$xml_writer

)

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

Parameters

ilXmlWriter

$xml_writer

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

References ilUserDefinedFields\_getInstance().

Referenced by toXML().

    {
        include_once './Services/User/classes/class.ilUserDefinedFields.php';
        $udf_obj = &ilUserDefinedFields::_getInstance();

        foreach ($udf_obj->getDefinitions() as $definition) {
            if ($definition["export"] != false) {
                $xml_writer->xmlElement(
                    'UserDefinedField',
                    array('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 (   $a_field_id )

static

Delete data of particular field.

Parameters

int

field id

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

References $DIC, and $ilDB.

Referenced by ilUserDefinedFields\delete().

    {
        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 (   $a_user_id )

static

Delete data of user.

Parameters

int

user id

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

References $DIC, and $ilDB.

Referenced by ilObjUser\deleteUserDefinedFieldEntries().

    {
        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 (   $a_field_id,   $a_value  )

static

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

Parameters

int	field id
string	value

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

References $DIC, and $ilDB.

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

    {
        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

(

$a_field

)

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

    {
        return isset($this->user_data[$a_field]) ? $this->user_data[$a_field] : '';
    }

getAll()

ilUserDefinedData::getAll

(

)

Get all fields.

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

References $user_data.

    {
        return $this->user_data;
    }

getUserId()

ilUserDefinedData::getUserId

(

)

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

References $usr_id.

Referenced by update().

    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

lookupData()

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

static

Lookup data.

Parameters

array	$a_user_ids
array	$a_field_ids

Returns

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

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_ASSOC, and ilCustomUserFieldsHelper\getInstance().

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

    {
        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 = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $udfd[$row['usr_id']][$row['field_id']] = $row['value'];
        }
        
        include_once './Services/User/classes/class.ilCustomUserFieldsHelper.php';
        $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	(		$a_field,
			$a_value
	)

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

Referenced by ilUserImportParser\importEndTag().

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

Here is the caller graph for this function:

toXML()

ilUserDefinedData::toXML

(

)

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

References addToXML().

    {
        include_once './Services/Xml/classes/class.ilXmlWriter.php';
        $xml_writer = new ilXmlWriter();

        $this->addToXML($xml_writer);

        return $xml_writer->xmlDumpMem(false);
    }

Here is the call graph for this function:

update()

ilUserDefinedData::update

(

)

Update data.

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        include_once './Services/User/classes/class.ilUserDefinedFields.php';
        $udf_obj = &ilUserDefinedFields::_getInstance();

        $sql = '';
        $field_def = array();
        foreach ($udf_obj->getDefinitions() as $definition) {
            //                  $field_def['f_'.$definition['field_id']] = array('text',$this->get($definition['field_id']));
            
            //                  $sql .= ("`".(int) $definition['field_id']."` = ".$this->db->quote($this->get($definition['field_id'])).", ");

            if ($definition["field_type"] == UDF_TYPE_WYSIWYG) {
                $ilDB->replace(
                    "udf_clob",
                    array(
                        "usr_id" => array("integer", $this->getUserId()),
                        "field_id" => array("integer", $definition['field_id'])),
                    array(
                        "value" => array("clob", $this->get("f_" . $definition['field_id']))
                        )
                );
            } else {
                $ilDB->replace(
                    "udf_text",
                    array(
                        "usr_id" => array("integer", $this->getUserId()),
                        "field_id" => array("integer", $definition['field_id'])),
                    array(
                        "value" => array("text", $this->get("f_" . $definition['field_id']))
                        )
                );
            }
        }
        /*              if(!$field_def)
                {
                    return true;
                }

                $query = "SELECT usr_id FROM udf_data WHERE usr_id = ".$ilDB->quote($this->getUserId(),'integer');
                $res = $ilDB->query($query);

                if($res->numRows())
                {
                    $ilDB->update('udf_data',$field_def,array('usr_id' => array('integer',$this->getUserId())));
                }
                else
                {
                    $field_def['usr_id'] = array('integer',$this->getUserId());
                    $ilDB->insert('udf_data',$field_def);
                }*/
        return true;
    }

Here is the call graph for this function:

Field Documentation

$db

ilUserDefinedData::$db = null

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

$user_data

ilUserDefinedData::$user_data = array()

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

Referenced by getAll().

$usr_id

ilUserDefinedData::$usr_id = null

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

Referenced by getUserId().

---

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

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