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

Inheritance diagram for ilDclBaseRecordFieldModel:

Collaboration diagram for ilDclBaseRecordFieldModel:

Public Member Functions
	__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
	doRead ()
	Read object data from database. More...

	loadValue ()
	Load the value. More...

Protected Attributes
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.ilDclBaseRecordFieldModel.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilDclBaseRecordModel	$record
ilDclBaseFieldModel	$field

Definition at line 39 of file class.ilDclBaseRecordFieldModel.php.

References $DIC, $field, $record, ILIAS\Repository\ctrl(), doRead(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->record = $record;
         $this->field = $field;
         $this->ctrl = $DIC->ctrl();
         $this->user = $DIC->user();
         $this->db = $DIC->database();
         $this->lng = $DIC->language();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->doRead();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addHiddenItemsToConfirmation()

ilDclBaseRecordFieldModel::addHiddenItemsToConfirmation ( ilConfirmationGUI $confirmation )

Parameters

ilConfirmationGUI $confirmation

Definition at line 285 of file class.ilDclBaseRecordFieldModel.php.

References ILIAS\LTI\ToolProvider\$key, $value, ilConfirmationGUI\addHiddenItem(), and getValue().

     {
         ;
         if (!is_array($this->getValue())) {
             $confirmation->addHiddenItem('field_' . $this->field->getId(), (string) $this->getValue());
         } else {
             foreach ($this->getValue() as $key => $value) {
                 $confirmation->addHiddenItem('field_' . $this->field->getId() . "[$key]", $value);
             }
         }
     }

Here is the call graph for this function:

◆ afterClone()

ilDclBaseRecordFieldModel::afterClone ( )

Definition at line 340 of file class.ilDclBaseRecordFieldModel.php.

                                 : void
     {
     }

◆ cloneStructure()

ilDclBaseRecordFieldModel::cloneStructure ( ilDclBaseRecordFieldModel $old_record_field )

Parameters

ilDclBaseRecordFieldModel $old_record_field

Definition at line 331 of file class.ilDclBaseRecordFieldModel.php.

References doUpdate(), getValue(), and setValue().

                                                                                : void
     {
         $this->setValue($old_record_field->getValue());
         $this->doUpdate();
     }

Here is the call graph for this function:

◆ delete()

ilDclBaseRecordFieldModel::delete ( )

Delete record field in database.

Definition at line 128 of file class.ilDclBaseRecordFieldModel.php.

References $query, and getField().

                             : void
     {
         $datatype = $this->getField()->getDatatype();
         $storage_location = ($this->getField()->getStorageLocationOverride() !== null) ? $this->getField()->getStorageLocationOverride() : $datatype->getStorageLocation();
 
         if ($storage_location != 0) {
             $query = "DELETE FROM il_dcl_stloc" . $storage_location . "_value WHERE record_field_id = "
                 . $this->db->quote($this->id, "integer");
             $this->db->manipulate($query);
         }
 
         $query2 = "DELETE FROM il_dcl_record_field WHERE id = " . $this->db->quote($this->id, "integer");
         $this->db->manipulate($query2);
     }

Here is the call graph for this function:

◆ deserializeData()

ilDclBaseRecordFieldModel::deserializeData ( $value )

Deserialize data before applying to field.

Parameters

mixed $value

Returns: mixed

Definition at line 180 of file class.ilDclBaseRecordFieldModel.php.

References $value.

Referenced by loadValue().

     {
         $deserialize = json_decode($value, true);
         if (is_array($deserialize)) {
             return $deserialize;
         }
 
         return $value;
     }

Here is the caller graph for this function:

◆ doCreate()

ilDclBaseRecordFieldModel::doCreate ( )

Creates an Id and a database entry.

Definition at line 78 of file class.ilDclBaseRecordFieldModel.php.

References $id, $query, getField(), getId(), and getRecord().

Referenced by doUpdate().

                               : void
     {
         $id = $this->db->nextId("il_dcl_record_field");
         $query = "INSERT INTO il_dcl_record_field (id, record_id, field_id) VALUES (" . $this->db->quote(
             $id,
             "integer"
         ) . ", "
             . $this->db->quote(
                 $this->getRecord()->getId(),
                 "integer"
             ) . ", " . $this->db->quote($this->getField()->getId(), "text") . ")";
         $this->db->manipulate($query);
         $this->id = $id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doRead()

ilDclBaseRecordFieldModel::doRead ( )

protected

Read object data from database.

Definition at line 57 of file class.ilDclBaseRecordFieldModel.php.

References $query, getField(), getId(), getRecord(), and loadValue().

Referenced by __construct().

                                : void
     {
         if (!$this->getRecord()->getId()) {
             return;
         }
 
         $query = "SELECT * FROM il_dcl_record_field WHERE field_id = " . $this->db->quote(
             $this->getField()->getId(),
             "integer"
         ) . " AND record_id = "
             . $this->db->quote($this->getRecord()->getId(), "integer");
         $set = $this->db->query($query);
         $rec = $this->db->fetchAssoc($set);
         $this->id = $rec['id'] ?? null;
 
         $this->loadValue();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilDclBaseRecordFieldModel::doUpdate ( )

Update object in database.

Definition at line 96 of file class.ilDclBaseRecordFieldModel.php.

References $query, $value, doCreate(), getField(), getId(), and serializeData().

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclFileuploadRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), cloneStructure(), and ilDclReferenceRecordRepresentation\getHTML().

                               : void
     {
         //$this->loadValue(); //Removed Mantis #0011799
         $datatype = $this->getField()->getDatatype();
         $storage_location = ($this->getField()->getStorageLocationOverride() !== null) ? $this->getField()->getStorageLocationOverride() : $datatype->getStorageLocation();
 
         if ($storage_location != 0) {
             $query = "DELETE FROM il_dcl_stloc" . $storage_location . "_value WHERE record_field_id = "
                 . $this->db->quote($this->id, "integer");
             $this->db->manipulate($query);
 
             $next_id = $this->db->nextId("il_dcl_stloc" . $storage_location . "_value");
 
             $value = $this->serializeData($this->value);
 
             if ($this->getId() == 0) {
                 $this->doCreate();
             }
 
             $insert_params = array(
                 "value" => array($datatype->getDbType(), $value),
                 "record_field_id" => array("integer", $this->getId()),
                 "id" => array("integer", $next_id),
             );
 
             $this->db->insert("il_dcl_stloc" . $storage_location . "_value", $insert_params);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillExcelExport()

ilDclBaseRecordFieldModel::fillExcelExport	(	ilExcel	$worksheet,
		int &	$row,
		int &	$col
	)

Definition at line 259 of file class.ilDclBaseRecordFieldModel.php.

References getExportValue(), and ilExcel\setCell().

                                                                              : void
     {
         $worksheet->setCell($row, $col, $this->getExportValue());
         $col++;
     }

Here is the call graph for this function:

◆ getExportValue()

ilDclBaseRecordFieldModel::getExportValue ( )

Returns: int|string

Definition at line 254 of file class.ilDclBaseRecordFieldModel.php.

References getValue(), and parseExportValue().

Referenced by ilDclTextSelectionRecordFieldModel\fillExcelExport(), fillExcelExport(), getFormulaValue(), and getPlainText().

     {
         return $this->parseExportValue($this->getValue());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getField()

ilDclBaseRecordFieldModel::getField ( )

Definition at line 344 of file class.ilDclBaseRecordFieldModel.php.

References $field.

                               : ilDclBaseFieldModel
     {
         return $this->field;
     }

Here is the caller graph for this function:

◆ getFieldRepresentation()

ilDclBaseRecordFieldModel::getFieldRepresentation ( )

Definition at line 369 of file class.ilDclBaseRecordFieldModel.php.

References $field_representation.

                                             : ?ilDclBaseFieldRepresentation
     {
         return $this->field_representation;
     }

◆ getFormulaValue()

ilDclBaseRecordFieldModel::getFormulaValue ( )

Definition at line 217 of file class.ilDclBaseRecordFieldModel.php.

References getExportValue().

                                      : string
     {
         return (string) $this->getExportValue();
     }

Here is the call graph for this function:

◆ getId()

ilDclBaseRecordFieldModel::getId ( )

Definition at line 349 of file class.ilDclBaseRecordFieldModel.php.

References $id.

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclFileuploadRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), ilDclRatingRecordFieldModel\delete(), doCreate(), doRead(), doUpdate(), ilDclRatingRecordFieldModel\getExportValue(), ilDclCache\getRecordFieldCache(), ilDclCache\getRecordRepresentation(), ilDclFieldFactory\getRecordRepresentationInstance(), ilDclRatingRecordFieldModel\getValue(), ilDclDateSelectionRecordFieldModel\parseExportValue(), ilDclSelectionRecordFieldModel\parseExportValue(), ilDclFileuploadRecordFieldModel\parseValue(), ilDclMobRecordFieldModel\parseValue(), ilDclTextRecordFieldModel\setValueFromForm(), ilDclCopyRecordFieldModel\setValueFromForm(), ilDclFileuploadRecordFieldModel\setValueFromForm(), ilDclMobRecordFieldModel\setValueFromForm(), and setValueFromForm().

                            : ?int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getPlainText()

ilDclBaseRecordFieldModel::getPlainText ( )

Returns: int|string

Definition at line 268 of file class.ilDclBaseRecordFieldModel.php.

References getExportValue().

     {
         return $this->getExportValue();
     }

Here is the call graph for this function:

◆ getRecord()

ilDclBaseRecordFieldModel::getRecord ( )

Definition at line 354 of file class.ilDclBaseRecordFieldModel.php.

References $record.

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclFileuploadRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), doCreate(), doRead(), ilDclRatingRecordFieldModel\getExportValue(), ilDclRatingRecordFieldModel\getValue(), ilDclFormulaRecordFieldModel\parse(), ilDclFileuploadRecordFieldModel\parseValue(), ilDclMobRecordFieldModel\parseValue(), and ilDclFileuploadRecordFieldModel\setValue().

                                : ilDclBaseRecordModel
     {
         return $this->record;
     }

Here is the caller graph for this function:

◆ getRecordRepresentation()

ilDclBaseRecordFieldModel::getRecordRepresentation ( )

Definition at line 359 of file class.ilDclBaseRecordFieldModel.php.

References $record_representation.

                                              : ?ilDclBaseRecordRepresentation
     {
         return $this->record_representation;
     }

◆ getSortingValue()

ilDclBaseRecordFieldModel::getSortingValue ( bool $link = true )

Parameters

bool $link

Returns: int|string

Definition at line 277 of file class.ilDclBaseRecordFieldModel.php.

References getValue(), and parseSortingValue().

     {
         return $this->parseSortingValue($this->getValue(), $link);
     }

Here is the call graph for this function:

◆ getValue()

ilDclBaseRecordFieldModel::getValue ( )

Returns: string|array

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

References $value, and loadValue().

Referenced by ilDclTextRecordFieldModel\addHiddenItemsToConfirmation(), ilDclFileuploadRecordFieldModel\addHiddenItemsToConfirmation(), ilDclMobRecordFieldModel\addHiddenItemsToConfirmation(), addHiddenItemsToConfirmation(), cloneStructure(), ilDclReferenceRecordFieldModel\getExportValue(), ilDclIliasReferenceRecordFieldModel\getExportValue(), ilDclTextRecordFieldModel\getExportValue(), getExportValue(), ilDclTextRecordFieldModel\getPlainText(), getSortingValue(), ilDclIliasReferenceRecordFieldModel\getStatus(), ilDclIliasReferenceRecordFieldModel\getValueForRepresentation(), getValueForRepresentation(), ilDclFileuploadRecordFieldModel\parseValue(), and ilDclMobRecordFieldModel\parseValue().

     {
         $this->loadValue();
 
         return $this->value;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValueForRepresentation()

ilDclBaseRecordFieldModel::getValueForRepresentation ( )

Returns: array|string

Definition at line 156 of file class.ilDclBaseRecordFieldModel.php.

References getValue().

     {
         return $this->getValue();
     }

Here is the call graph for this function:

◆ getValueFromExcel()

ilDclBaseRecordFieldModel::getValueFromExcel	(	ilExcel	$excel,
		int	$row,
		int	$col
	)

Returns: int|string

Definition at line 235 of file class.ilDclBaseRecordFieldModel.php.

References $value, and ilExcel\getCell().

     {
         $value = $excel->getCell($row, $col) ?? '';
         return $value;
     }

Here is the call graph for this function:

◆ loadValue()

ilDclBaseRecordFieldModel::loadValue ( )

protected

Load the value.

Definition at line 310 of file class.ilDclBaseRecordFieldModel.php.

References $query, $value, deserializeData(), and getField().

Referenced by doRead(), getValue(), ilDclFileuploadRecordFieldModel\setValue(), and setValue().

                                   : void
     {
         if ($this->value === null) {
             $datatype = $this->getField()->getDatatype();
 
             $storage_location = ($this->getField()->getStorageLocationOverride() !== null) ? $this->getField()->getStorageLocationOverride() : $datatype->getStorageLocation();
             if ($storage_location != 0) {
                 $query = "SELECT * FROM il_dcl_stloc" . $storage_location . "_value WHERE record_field_id = "
                     . $this->db->quote($this->id, "integer");
 
                 $set = $this->db->query($query);
                 $rec = $this->db->fetchAssoc($set);
                 $value = $this->deserializeData($rec['value'] ?? null);
                 $this->value = $value;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseExportValue()

ilDclBaseRecordFieldModel::parseExportValue ( $value )

Function to parse incoming data from form input value $value.

returns the string/number/etc. to store in the database.

Parameters

mixed $value

Returns: mixed

Definition at line 227 of file class.ilDclBaseRecordFieldModel.php.

References $value.

Referenced by getExportValue().

     {
         return $value;
     }

Here is the caller graph for this function:

◆ parseSortingValue()

ilDclBaseRecordFieldModel::parseSortingValue	(		$value,
		bool	$link = `true`
	)

Returns sortable value for the specific field-types.

Parameters

int | string $value

Returns: int|string

Definition at line 302 of file class.ilDclBaseRecordFieldModel.php.

References $value.

Referenced by getSortingValue().

     {
         return $value;
     }

Here is the caller graph for this function:

◆ parseValue()

ilDclBaseRecordFieldModel::parseValue ( $value )

Function to parse incoming data from form input value $value.

returns the string/number/etc. to store in the database.

Parameters

int | string $value

Returns: int|string|null

Definition at line 246 of file class.ilDclBaseRecordFieldModel.php.

References $value.

Referenced by setValue().

     {
         return $value;
     }

Here is the caller graph for this function:

◆ serializeData()

ilDclBaseRecordFieldModel::serializeData ( $value )

Serialize data before storing to db.

Parameters

mixed $value

Returns: mixed

Definition at line 166 of file class.ilDclBaseRecordFieldModel.php.

References $value.

Referenced by doUpdate().

     {
         if (is_array($value)) {
             $value = json_encode($value);
         }
 
         return $value;
     }

Here is the caller graph for this function:

◆ setFieldRepresentation()

ilDclBaseRecordFieldModel::setFieldRepresentation ( ilDclBaseFieldRepresentation $field_representation )

Definition at line 374 of file class.ilDclBaseRecordFieldModel.php.

References $field_representation.

                                                                                               : void
     {
         $this->field_representation = $field_representation;
     }

◆ setRecordRepresentation()

ilDclBaseRecordFieldModel::setRecordRepresentation ( ilDclBaseRecordRepresentation $record_representation )

Definition at line 364 of file class.ilDclBaseRecordFieldModel.php.

References $record_representation.

                                                                                                  : void
     {
         $this->record_representation = $record_representation;
     }

◆ setValue()

ilDclBaseRecordFieldModel::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 195 of file class.ilDclBaseRecordFieldModel.php.

References $value, loadValue(), and parseValue().

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), cloneStructure(), ilDclReferenceRecordRepresentation\getHTML(), ilDclTextRecordFieldModel\setValueFromForm(), ilDclCopyRecordFieldModel\setValueFromForm(), ilDclMobRecordFieldModel\setValueFromForm(), and setValueFromForm().

                                                                 : void
     {
         $this->loadValue();
         if (!$omit_parsing) {
             $tmp = $this->parseValue($value);
             $old = $this->value;
             //if parse value fails keep the old value
             if ($tmp !== false) {
                 $this->value = $tmp;
             }
         } else {
             $this->value = $value;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueFromForm()

ilDclBaseRecordFieldModel::setValueFromForm ( ilPropertyFormGUI $form )

Definition at line 210 of file class.ilDclBaseRecordFieldModel.php.

References $value, getField(), getId(), ilPropertyFormGUI\getInput(), and setValue().

                                                              : void
     {
         $value = $form->getInput("field_" . $this->getField()->getId());
 
         $this->setValue($value);
     }