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 ()

	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

Private Member Functions
	getDBType (int $storage_location)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilDclBaseRecordModel	$record
ilDclBaseFieldModel	$field

Reimplemented in ilDclFileRecordFieldModel, ilDclFormulaRecordFieldModel, ilDclIliasReferenceRecordFieldModel, ilDclRatingRecordFieldModel, and ilDclReferenceRecordFieldModel.

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

    {
        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();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addHiddenItemsToConfirmation()

ilDclBaseRecordFieldModel::addHiddenItemsToConfirmation ( ilConfirmationGUI $confirmation )

Parameters

ilConfirmationGUI $confirmation

Reimplemented in ilDclFormulaRecordFieldModel, ilDclRatingRecordFieldModel, and ilDclTextRecordFieldModel.

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

    {
        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]", (string) $value);
            }
        }
    }

References $value, ilConfirmationGUI\addHiddenItem(), and getValue().

Here is the call graph for this function:

◆ afterClone()

ilDclBaseRecordFieldModel::afterClone ( )

Reimplemented in ilDclFileRecordFieldModel, ilDclMobRecordFieldModel, and ilDclReferenceRecordFieldModel.

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

                                : void
    {
    }

◆ cloneStructure()

ilDclBaseRecordFieldModel::cloneStructure ( ilDclBaseRecordFieldModel $old_record_field )

Parameters

ilDclBaseRecordFieldModel $old_record_field

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

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

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

Here is the call graph for this function:

◆ delete()

ilDclBaseRecordFieldModel::delete ( )

Delete record field in database.

Reimplemented in ilDclFileRecordFieldModel, ilDclFormulaRecordFieldModel, and ilDclRatingRecordFieldModel.

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

                            : 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);
    }

References getField().

Here is the call graph for this function:

◆ deserializeData()

ilDclBaseRecordFieldModel::deserializeData ( $value )

Deserialize data before applying to field.

Parameters

mixed $value

Returns: mixed

Reimplemented in ilDclCopyRecordFieldModel, and ilDclTextRecordFieldModel.

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

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

References $value.

Referenced by loadValue().

Here is the caller graph for this function:

◆ doCreate()

ilDclBaseRecordFieldModel::doCreate ( )

Creates an Id and a database entry.

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

                              : 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;
    }

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

Referenced by doUpdate().

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.

Reimplemented in ilDclFormulaRecordFieldModel, and ilDclRatingRecordFieldModel.

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

                               : 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();
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilDclBaseRecordFieldModel::doUpdate ( )

Update object in database.

Reimplemented in ilDclFormulaRecordFieldModel, and ilDclRatingRecordFieldModel.

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

                              : 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, ilDBConstants::T_INTEGER);
            $this->db->manipulate($query);
 
            $next_id = $this->db->nextId("il_dcl_stloc" . $storage_location . "_value");
 
            $value = $this->serializeData($this->value);
 
            if (empty($this->getId())) {
                $this->doCreate();
            }
 
            $insert_params = [
                'value' => [$this->getDbType($storage_location), $value],
                'record_field_id' => [ilDBConstants::T_INTEGER, $this->getId()],
                'id' => [ilDBConstants::T_INTEGER, $next_id],
            ];
 
            $this->db->insert("il_dcl_stloc" . $storage_location . "_value", $insert_params);
        }
    }

References $value, doCreate(), getField(), getId(), serializeData(), and ilDBConstants\T_INTEGER.

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

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
	)

Reimplemented in ilDclTextRecordFieldModel, and ilDclTextSelectionRecordFieldModel.

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

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

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

Here is the call graph for this function:

◆ getDBType()

ilDclBaseRecordFieldModel::getDBType ( int $storage_location )

private

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

                                                     : string
    {
        switch ($storage_location) {
            case 1:
                return ilDBConstants::T_TEXT;
            case 2:
                return ilDBConstants::T_INTEGER;
            case 3:
                return ilDBConstants::T_DATE;
            default:
                throw new InvalidArgumentException('Unsupported storage_location: ' . $storage_location);
        }
    }

References ilDBConstants\T_DATE, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

◆ getExportValue()

ilDclBaseRecordFieldModel::getExportValue ( )

Returns: int|string

Reimplemented in ilDclFormulaRecordFieldModel, ilDclIliasReferenceRecordFieldModel, ilDclRatingRecordFieldModel, ilDclReferenceRecordFieldModel, and ilDclTextRecordFieldModel.

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

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

References getValue(), and parseExportValue().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getField()

ilDclBaseRecordFieldModel::getField ( )

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

                              : ilDclBaseFieldModel
    {
        return $this->field;
    }

References $field.

Here is the caller graph for this function:

◆ getFieldRepresentation()

ilDclBaseRecordFieldModel::getFieldRepresentation ( )

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

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

References $field_representation.

◆ getFormulaValue()

ilDclBaseRecordFieldModel::getFormulaValue ( )

Reimplemented in ilDclDateRecordFieldModel, and ilDclDatetimeRecordFieldModel.

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

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

References getExportValue().

Here is the call graph for this function:

◆ getId()

ilDclBaseRecordFieldModel::getId ( )

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

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

References $id.

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

Here is the caller graph for this function:

◆ getPlainText()

ilDclBaseRecordFieldModel::getPlainText ( )

Returns: int|string

Reimplemented in ilDclTextRecordFieldModel.

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

    {
        return $this->getExportValue();
    }

References getExportValue().

Here is the call graph for this function:

◆ getRecord()

ilDclBaseRecordFieldModel::getRecord ( )

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

                               : ilDclBaseRecordModel
    {
        return $this->record;
    }

References $record.

Referenced by ilDclFileRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), ilDclReferenceRecordFieldModel\afterClone(), ilDclFileRecordRepresentation\buildDownloadLink(), doCreate(), doRead(), ilDclRatingRecordFieldModel\getExportValue(), ilDclRatingRecordFieldModel\getValue(), ilDclFormulaRecordFieldModel\parse(), ilDclFileRecordFieldModel\parseValue(), and ilDclMobRecordFieldModel\parseValue().

Here is the caller graph for this function:

◆ getRecordRepresentation()

ilDclBaseRecordFieldModel::getRecordRepresentation ( )

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

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

References $record_representation.

◆ getSortingValue()

ilDclBaseRecordFieldModel::getSortingValue ( bool $link = true )

Parameters

bool $link

Returns: int|string

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

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

References getValue(), and parseSortingValue().

Here is the call graph for this function:

◆ getValue()

ilDclBaseRecordFieldModel::getValue ( )

Returns: string|array

Reimplemented in ilDclFormulaRecordFieldModel, ilDclRatingRecordFieldModel, and ilDclSelectionRecordFieldModel.

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

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

References $value, and loadValue().

Referenced by addHiddenItemsToConfirmation(), ilDclTextRecordFieldModel\addHiddenItemsToConfirmation(), cloneStructure(), getExportValue(), ilDclIliasReferenceRecordFieldModel\getExportValue(), ilDclReferenceRecordFieldModel\getExportValue(), ilDclTextRecordFieldModel\getExportValue(), ilDclDateRecordFieldModel\getFormulaValue(), ilDclDatetimeRecordFieldModel\getFormulaValue(), ilDclTextRecordFieldModel\getPlainText(), getSortingValue(), ilDclIliasReferenceRecordFieldModel\getStatus(), ilDclFileRecordFieldModel\parseValue(), ilDclMobRecordFieldModel\parseValue(), and ilDclDatetimeRecordFieldModel\setValueFromForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValueFromExcel()

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

Returns: string

Reimplemented in ilDclDateRecordFieldModel, ilDclDatetimeRecordFieldModel, ilDclReferenceRecordFieldModel, ilDclSelectionRecordFieldModel, and ilDclTextRecordFieldModel.

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

    {
        return (string) $excel->getCell($row, $col);
    }

References ilExcel\getCell().

Here is the call graph for this function:

◆ loadValue()

ilDclBaseRecordFieldModel::loadValue ( )

protected

Load the value.

Reimplemented in ilDclFormulaRecordFieldModel, and ilDclRatingRecordFieldModel.

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

                                  : 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;
            }
        }
    }

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

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

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

Reimplemented in ilDclBooleanRecordFieldModel, ilDclFileRecordFieldModel, ilDclMobRecordFieldModel, and ilDclSelectionRecordFieldModel.

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

    {
        return $value;
    }

References $value.

Referenced by getExportValue().

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

Reimplemented in ilDclDateRecordFieldModel, ilDclDatetimeRecordFieldModel, ilDclFileRecordFieldModel, ilDclMobRecordFieldModel, and ilDclTextRecordFieldModel.

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

    {
        return $value;
    }

References $value.

Referenced by getSortingValue().

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

Reimplemented in ilDclBooleanRecordFieldModel, ilDclDateRecordFieldModel, ilDclDatetimeRecordFieldModel, ilDclFileRecordFieldModel, ilDclMobRecordFieldModel, and ilDclNumberRecordFieldModel.

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

    {
        return $value;
    }

References $value.

Referenced by setValue().

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

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

References $value.

Referenced by doUpdate().

Here is the caller graph for this function:

◆ setFieldRepresentation()

ilDclBaseRecordFieldModel::setFieldRepresentation ( ilDclBaseFieldRepresentation $field_representation )

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

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

References $field_representation.

◆ setRecordRepresentation()

ilDclBaseRecordFieldModel::setRecordRepresentation ( ilDclBaseRecordRepresentation $record_representation )

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

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

References $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

Reimplemented in ilDclFormulaRecordFieldModel, and ilDclRatingRecordFieldModel.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueFromForm()

ilDclBaseRecordFieldModel::setValueFromForm ( ilPropertyFormGUI $form )

Reimplemented in ilDclCopyRecordFieldModel, ilDclDatetimeRecordFieldModel, ilDclFileRecordFieldModel, and ilDclTextRecordFieldModel.

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

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