Inheritance diagram for ilDataCollectionRatingField:

Collaboration diagram for ilDataCollectionRatingField:

Public Member Functions
	__construct (ilDataCollectionRecord $record, ilDataCollectionField $field)

	setValue ($value)

	doUpdate ()
	Update object in database. More...

	doRead ()
	Read object data from database. More...

	getFormInput ()

	getHTML ()

	getExportValue ()

	getValue ()

	delete ()
	delete More...

Public Member Functions inherited from ilDataCollectionRecordField
	__construct (ilDataCollectionRecord $record, ilDataCollectionField $field)

	doUpdate ()
	Update object in database. More...

	delete ()
	Delete record field in database. More...

	getValue ()

	setValue ($value, $omit_parsing=false)
	Set value for record field. More...

	getFormInput ()

	getExportValue ()

	getPlainText ()

	getHTML ($link=true)

	getSortingValue ($link=true)

	getSingleHTML ()

	getField ()

	getId ()

	getRecord ()

Protected Member Functions
	loadValue ()
	override the loadValue. More...

Protected Member Functions inherited from ilDataCollectionRecordField
	doRead ()
	Read object data from database. More...

	doCreate ()
	Create object in database. More...

	loadValue ()
	Load the value. More...

Protected Attributes
	$rated

	$dcl_obj_id

Protected Attributes inherited from ilDataCollectionRecordField
	$id

	$field

	$record

	$value

	$lng

	$user

	$ctrl

	$db

Detailed Description

Class ilDataCollectionField.

Author: Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Marcel Raimann mr@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id:

Definition at line 19 of file class.ilDataCollectionRatingField.php.

Constructor & Destructor Documentation

◆ __construct()

ilDataCollectionRatingField::__construct	(	ilDataCollectionRecord	$record,
		ilDataCollectionField	$field
	)

Parameters

ilDataCollectionRecord	$record
ilDataCollectionField	$field

Reimplemented from ilDataCollectionRecordField.

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

                                                                                                 {
                parent::__construct($record, $field);
                $dclTable = ilDataCollectionCache::getTableCache($this->getField()->getTableId());
                $this->dcl_obj_id = $dclTable->getCollectionObject()->getId();
        }

References ilDataCollectionRecordField\$field, ilDataCollectionRecordField\$record, ilDataCollectionRecordField\getField(), and ilDataCollectionCache\getTableCache().

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilDataCollectionRatingField::delete ( )

delete

Reimplemented from ilDataCollectionRecordField.

Definition at line 87 of file class.ilDataCollectionRatingField.php.

        {
                global $ilDB;
 
                $ilDB->manipulate("DELETE FROM il_rating WHERE ".
                        "obj_id = ".$ilDB->quote((int) $this->getRecord()->getId(), "integer")." AND ".
                        "obj_type = ".$ilDB->quote("dcl_record", "text")." AND ".
                        "sub_obj_id = ".$ilDB->quote((int) $this->getField()->getId(), "integer")." AND ".
                        $ilDB->equals("sub_obj_type", "dcl_field", "text", true));
 
                $query2 = "DELETE FROM il_dcl_record_field WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($query2);
        }

References $ilDB, ilDataCollectionRecordField\getField(), and ilDataCollectionRecordField\getId().

Here is the call graph for this function:

◆ doRead()

ilDataCollectionRatingField::doRead ( )

Read object data from database.

Reimplemented from ilDataCollectionRecordField.

Definition at line 52 of file class.ilDataCollectionRatingField.php.

                                {
                // explicitly do nothing. the value is handled via the model and gui of ilRating.
        }

◆ doUpdate()

ilDataCollectionRatingField::doUpdate ( )

Update object in database.

Reimplemented from ilDataCollectionRecordField.

Definition at line 48 of file class.ilDataCollectionRatingField.php.

                                  {
                // explicitly do nothing. the value is handled via the model and gui of ilRating.
        }

◆ getExportValue()

ilDataCollectionRatingField::getExportValue ( )

Returns: int|string

Reimplemented from ilDataCollectionRecordField.

Definition at line 73 of file class.ilDataCollectionRatingField.php.

                                        {
        $val = ilRating::getOverallRatingForObject($this->getRecord()->getId(), "dcl_record",
            $this->getField()->getId(), "dcl_field");
        return  round($val["avg"],1)." (".$val["cnt"].")";
        }

References ilDataCollectionRecordField\getField(), ilDataCollectionRecordField\getId(), ilRating\getOverallRatingForObject(), and ilDataCollectionRecordField\getRecord().

Here is the call graph for this function:

◆ getFormInput()

ilDataCollectionRatingField::getFormInput ( )

Returns: mixed

Reimplemented from ilDataCollectionRecordField.

Definition at line 56 of file class.ilDataCollectionRatingField.php.

                                      {
                global $lng;
                return $lng->txt("dcl_editable_in_table_gui");
        }

References ilDataCollectionRecordField\$lng.

◆ getHTML()

ilDataCollectionRatingField::getHTML ( )

Definition at line 61 of file class.ilDataCollectionRatingField.php.

                                 {
                global $ilCtrl;
                $rgui = new ilRatingGUI();
                $rgui->setObject($this->getRecord()->getId(), "dcl_record",
                $this->getField()->getId(), "dcl_field");
                $ilCtrl->setParameterByClass("ilratinggui", "field_id", $this->getField()->getId());
                $ilCtrl->setParameterByClass("ilratinggui", "record_id", $this->getRecord()->getId());
        $html = $rgui->getHTML();
 
                return $html;
        }

References $ilCtrl, ilDataCollectionRecordField\getField(), ilDataCollectionRecordField\getId(), and ilDataCollectionRecordField\getRecord().

Here is the call graph for this function:

◆ getValue()

ilDataCollectionRatingField::getValue ( )

Returns: string

Reimplemented from ilDataCollectionRecordField.

Definition at line 79 of file class.ilDataCollectionRatingField.php.

                                  {
                return ilRating::getOverallRatingForObject($this->getRecord()->getId(), "dcl_record",
                        $this->getField()->getId(), "dcl_field");
        }

References ilDataCollectionRecordField\getField(), ilDataCollectionRecordField\getId(), ilRating\getOverallRatingForObject(), and ilDataCollectionRecordField\getRecord().

Here is the call graph for this function:

◆ loadValue()

ilDataCollectionRatingField::loadValue ( )

protected

override the loadValue.

Reimplemented from ilDataCollectionRecordField.

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

                                      {
                // explicitly do nothing. we don't have to load the value as it is saved somewhere else.
        }

◆ setValue()

ilDataCollectionRatingField::setValue ( $value )

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

                                        {
                // explicitly do nothing. the value is handled via the model and gui of ilRating.
        }

Field Documentation

◆ $dcl_obj_id

ilDataCollectionRatingField::$dcl_obj_id

protected

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

◆ $rated

ilDataCollectionRatingField::$rated

protected

Definition at line 24 of file class.ilDataCollectionRatingField.php.

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

Modules/DataCollection/classes/class.ilDataCollectionRatingField.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ doRead()

◆ doUpdate()

◆ getExportValue()

◆ getFormInput()

◆ getHTML()

◆ getValue()

◆ loadValue()

◆ setValue()

Field Documentation

◆ $dcl_obj_id

◆ $rated