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

Collaboration diagram for ilCourseUserData:

Public Member Functions
	__construct (int $a_user_id, int $a_field_id=0)

	setValue (string $a_value)

	getValue ()

	update ()

	delete ()

	create ()

Static Public Member Functions
static	_getValuesByObjId (int $a_obj_id)

static	_checkRequired (int $a_usr_id, int $a_obj_id)

static	_deleteByUser (int $a_user_id)

static	_deleteByField (int $a_field_id)

Protected Attributes
ilDBInterface	$db

Private Member Functions
	read ()

Private Attributes
int	$user_id

int	$field_id

string	$value

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

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

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

Constructor & Destructor Documentation

◆ __construct()

ilCourseUserData::__construct	(	int	$a_user_id,
		int	$a_field_id = `0`
	)

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->user_id = $a_user_id;
        $this->field_id = $a_field_id;
        if ($this->field_id) {
            $this->read();
        }
    }

References $DIC, and read().

Here is the call graph for this function:

Member Function Documentation

◆ _checkRequired()

static ilCourseUserData::_checkRequired	(	int	$a_usr_id,
		int	$a_obj_id
	)

static

Definition at line 66 of file class.ilCourseUserData.php.

                                                                       : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $required = ilCourseDefinedFieldDefinition::_getRequiredFieldIds($a_obj_id);
        if ($required === []) {
            return true;
        }
 
        //$and = ("AND field_id IN (".implode(",",ilUtil::quoteArray($required)).")");
        $and = "AND " . $ilDB->in('field_id', $required, false, 'integer');
 
        $query = "SELECT COUNT(*) num_entries FROM crs_user_data " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND value != '' AND value IS NOT NULL " .
            $and . " " .
            " ";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        return $row->num_entries == count($required);
    }

References $DIC, $ilDB, $query, $res, ilCourseDefinedFieldDefinition\_getRequiredFieldIds(), and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjCourseGUI\checkAgreement(), ilObjGroupGUI\checkAgreement(), and ilMemberAgreementGUI\init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _deleteByField()

static ilCourseUserData::_deleteByField ( int $a_field_id )

static

Definition at line 99 of file class.ilCourseUserData.php.

                                                          : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "DELETE FROM crs_user_data " .
            "WHERE field_id = " . $ilDB->quote($a_field_id, 'integer');
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, and $res.

Referenced by ilCourseDefinedFieldDefinition\_deleteByContainer(), and ilCourseDefinedFieldDefinition\delete().

Here is the caller graph for this function:

◆ _deleteByUser()

static ilCourseUserData::_deleteByUser ( int $a_user_id )

static

Definition at line 89 of file class.ilCourseUserData.php.

                                                        : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "DELETE FROM crs_user_data " .
            "WHERE usr_id = " . $ilDB->quote($a_user_id, 'integer');
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, and $res.

◆ _getValuesByObjId()

static ilCourseUserData::_getValuesByObjId ( int $a_obj_id )

static

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

                                                           : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $field_ids = ilCourseDefinedFieldDefinition::_getFieldIds($a_obj_id);
        if ($field_ids === []) {
            return array();
        }
        $where = "WHERE " . $ilDB->in('field_id', $field_ids, false, 'integer');
        $query = "SELECT * FROM crs_user_data " .
            $where;
 
        $res = $ilDB->query($query);
        $user_data = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $user_data[(int) $row->usr_id][(int) $row->field_id] = $row->value;
        }
        return $user_data;
    }

References $DIC, $ilDB, $query, $res, ilCourseDefinedFieldDefinition\_getFieldIds(), ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilObjGroupGUI\addCustomData(), ilBookingReservationsTableGUI\getItems(), ilAttendanceList\getNonMemberUserData(), ilCourseMembershipGUI\getPrintMemberData(), ilCourseParticipantsTableGUI\parse(), ilGroupParticipantsTableGUI\parse(), ilMemberExport\readCourseSpecificFieldsData(), ilSubscriberTableGUI\readSubscriberData(), and ilWaitingListTableGUI\readUserData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilCourseUserData::create ( )

Definition at line 134 of file class.ilCourseUserData.php.

                            : void
    {
        $query = "INSERT INTO crs_user_data (value,usr_id,field_id) " .
            "VALUES( " .
            $this->db->quote($this->getValue(), 'text') . ", " .
            $this->db->quote($this->user_id, 'integer') . ", " .
            $this->db->quote($this->field_id, 'integer') . " " .
            ")";
 
        $res = $this->db->manipulate($query);
    }

References $query, $res, and getValue().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilCourseUserData::delete ( )

Definition at line 126 of file class.ilCourseUserData.php.

                            : void
    {
        $query = "DELETE FROM crs_user_data " .
            "WHERE usr_id = " . $this->db->quote($this->user_id, 'integer') . " " .
            "AND field_id = " . $this->db->quote($this->field_id, 'integer');
        $res = $this->db->manipulate($query);
    }

References $query, and $res.

◆ getValue()

ilCourseUserData::getValue ( )

Definition at line 115 of file class.ilCourseUserData.php.

                              : string
    {
        return $this->value;
    }

References $value.

Referenced by create().

Here is the caller graph for this function:

◆ read()

ilCourseUserData::read ( )

private

Definition at line 146 of file class.ilCourseUserData.php.

                           : void
    {
        $query = "SELECT * FROM crs_user_data " .
            "WHERE usr_id = " . $this->db->quote($this->user_id, 'integer') . " " .
            "AND field_id = " . $this->db->quote($this->field_id, 'integer');
        $res = $this->db->query($query);
        $this->setValue('');
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setValue((string) $row->value);
        }
    }

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, and setValue().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue()

ilCourseUserData::setValue ( string $a_value )

Definition at line 110 of file class.ilCourseUserData.php.

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

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilCourseUserData::update ( )

Definition at line 120 of file class.ilCourseUserData.php.

                            : void
    {
        $this->delete();
        $this->create();
    }

References create().

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilCourseUserData::$db

protected

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

◆ $field_id

int ilCourseUserData::$field_id

private

Definition at line 28 of file class.ilCourseUserData.php.

◆ $user_id

int ilCourseUserData::$user_id

private

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

◆ $value

string ilCourseUserData::$value

private

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

Referenced by getValue().

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

Modules/Course/classes/Export/class.ilCourseUserData.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _checkRequired()

◆ _deleteByField()

◆ _deleteByUser()

◆ _getValuesByObjId()

◆ create()

◆ delete()

◆ getValue()

◆ read()

◆ setValue()

◆ update()

Field Documentation

◆ $db

◆ $field_id

◆ $user_id

◆ $value