ilDclRatingRecordFieldModel Class Reference

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

Inheritance diagram for ilDclRatingRecordFieldModel:

Collaboration diagram for ilDclRatingRecordFieldModel:

Public Member Functions
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)
	setValue ($value, bool $omit_parsing=false)
	Set value for record field. More...
	doUpdate ()
	getExportValue ()
	return Export values More...
	getValue ()
	delete ()
	delete More...
Public Member Functions inherited from ilDclBaseRecordFieldModel
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	doCreate ()
	Creates an Id and a database entry. More...
	doUpdate ()
	Update object in database. More...
	delete ()
	Delete record field in database. More...
	getValue ()
	getValueForRepresentation ()
	serializeData ($value)
	Serialize data before storing to db. More...
	deserializeData ($value)
	Deserialize data before applying to field. More...
	setValue ($value, bool $omit_parsing=false)
	Set value for record field. More...
	setValueFromForm (ilPropertyFormGUI $form)
	getFormulaValue ()
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	getValueFromExcel (ilExcel $excel, int $row, int $col)
	parseValue ($value)
	Function to parse incoming data from form input value $value. More...
	getExportValue ()
	fillExcelExport (ilExcel $worksheet, int &$row, int &$col)
	getPlainText ()
	getSortingValue (bool $link=true)
	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)
	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...
	cloneStructure (ilDclBaseRecordFieldModel $old_record_field)
	afterClone ()
	getField ()
	getId ()
	getRecord ()
	getRecordRepresentation ()
	setRecordRepresentation (ilDclBaseRecordRepresentation $record_representation)
	getFieldRepresentation ()
	setFieldRepresentation (ilDclBaseFieldRepresentation $field_representation)

Protected Member Functions
	loadValue ()
	override the loadValue. More...
	doRead ()
Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...
	loadValue ()
	Load the value. More...

Protected Attributes
int	$dcl_obj_id
Protected Attributes inherited from ilDclBaseRecordFieldModel
int	$id = null
ilDclBaseFieldModel	$field
ilDclBaseRecordModel	$record
ilDclBaseRecordRepresentation	$record_representation = null
ilDclBaseFieldRepresentation	$field_representation = null
	$value
ilObjUser	$user
ilCtrl	$ctrl
ilDBInterface	$db
ilLanguage	$lng
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery

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

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

Constructor & Destructor Documentation

__construct()

ilDclRatingRecordFieldModel::__construct	(	ilDclBaseRecordModel	$record,
		ilDclBaseFieldModel	$field
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), ilDclBaseRecordFieldModel\getField(), and ilDclCache\getTableCache().

    {
        parent::__construct($record, $field);

        $dclTable = ilDclCache::getTableCache($this->getField()->getTableId());
        $this->dcl_obj_id = $dclTable->getCollectionObject()->getId();
    }

Here is the call graph for this function:

Member Function Documentation

addHiddenItemsToConfirmation()

ilDclRatingRecordFieldModel::addHiddenItemsToConfirmation

(

ilConfirmationGUI

$confirmation

)

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

                                                                                 : void
    {
    }

delete()

ilDclRatingRecordFieldModel::delete

(

)

delete

Definition at line 95 of file class.ilDclRatingRecordFieldModel.php.

References $DIC, $ilDB, ilDclBaseRecordFieldModel\getField(), and ilDclBaseRecordFieldModel\getId().

                            : void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $ilDB->manipulate(
            "DELETE FROM il_rating WHERE " .
            "obj_id = " . $ilDB->quote($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);
    }

Here is the call graph for this function:

doRead()

ilDclRatingRecordFieldModel::doRead ( )

protected

Definition at line 58 of file class.ilDclRatingRecordFieldModel.php.

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

doUpdate()

ilDclRatingRecordFieldModel::doUpdate

(

)

Definition at line 53 of file class.ilDclRatingRecordFieldModel.php.

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

getExportValue()

ilDclRatingRecordFieldModel::getExportValue

(

)

return Export values

Returns

string

Definition at line 67 of file class.ilDclRatingRecordFieldModel.php.

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

                                    : string
    {
        $val = ilRating::getOverallRatingForObject(
            $this->getRecord()->getId(),
            "dcl_record",
            $this->getField()->getId(),
            "dcl_field"
        );

        return round($val["avg"], 1) . " (" . $val["cnt"] . ")";
    }

Here is the call graph for this function:

getValue()

ilDclRatingRecordFieldModel::getValue

(

)

Returns

array

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

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

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

Here is the call graph for this function:

loadValue()

ilDclRatingRecordFieldModel::loadValue ( )

protected

override the loadValue.

Definition at line 38 of file class.ilDclRatingRecordFieldModel.php.

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

setValue()

ilDclRatingRecordFieldModel::setValue	(		$value,
		bool	$omit_parsing = false
	)

Set value for record field.

Parameters

mixed	$value
bool	$omit_parsing	If true, does not parse the value and stores it in the given format

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

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

Field Documentation

$dcl_obj_id

int ilDclRatingRecordFieldModel::$dcl_obj_id

protected

Definition at line 21 of file class.ilDclRatingRecordFieldModel.php.

---

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

• Modules/DataCollection/classes/Fields/Rating/class.ilDclRatingRecordFieldModel.php