Inheritance diagram for ilDclTextRecordFieldModel:

Collaboration diagram for ilDclTextRecordFieldModel:

Public Member Functions
	setValueFromForm (ilPropertyFormGUI $form)

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

	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)

	getPlainText ()

	getExportValue ()

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

	parseValue ($value)

	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...

	deserializeData ($value)

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)

Additional Inherited Members
Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...

	loadValue ()
	Load the value. More...

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

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

Member Function Documentation

◆ addHiddenItemsToConfirmation()

ilDclTextRecordFieldModel::addHiddenItemsToConfirmation ( ilConfirmationGUI $confirmation )

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

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

                                                                                  : void
     {
         if ($this->field->hasProperty(ilDclBaseFieldModel::PROP_URL)) {
             $value = $this->getValue();
             if (is_array($value)) {
                 $confirmation->addHiddenItem('field_' . $this->field->getId(), $value['link']);
                 $confirmation->addHiddenItem('field_' . $this->field->getId() . '_title', $value['title']);
             }
 
             return;
         }
         parent::addHiddenItemsToConfirmation($confirmation);
     }

Here is the call graph for this function:

◆ deserializeData()

ilDclTextRecordFieldModel::deserializeData ( $value )

Definition at line 159 of file class.ilDclTextRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), and ilDclBaseFieldModel\PROP_URL.

     {
         $value = (string) $value;
         if ($this->getField()->getProperty(ilDclBaseFieldModel::PROP_URL)) {
             $deserialize = json_decode($value, true);
             return [
                 'title' => $deserialize['title'] ?? '',
                 'link' => $deserialize['link'] ?? '',
             ];
         }
 
         return $value;
     }

Here is the call graph for this function:

◆ fillExcelExport()

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

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

References ilDclBaseRecordFieldModel\$value, getExportValue(), ilDclBaseRecordFieldModel\getField(), ilDclBaseFieldModel\PROP_URL, and ilExcel\setCell().

                                                                              : void
     {
         $value = $this->getExportValue();
 
         if ($this->getField()->getProperty(ilDclBaseFieldModel::PROP_URL)) {
             if (is_array($value)) {
                 $worksheet->setCell($row, $col, $value['link']);
                 $col++;
                 $worksheet->setCell($row, $col, $value['title']);
                 $col++;
             } else {
                 $worksheet->setCell($row, $col, $value);
                 $col += 2;
             }
         } else {
             $worksheet->setCell($row, $col, $value, DataType::TYPE_STRING);
             $col++;
         }
     }

Here is the call graph for this function:

◆ getExportValue()

ilDclTextRecordFieldModel::getExportValue ( )

Returns: array|float|int|mixed|string|null

Definition at line 93 of file class.ilDclTextRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getValue(), and ilDclBaseFieldModel\PROP_URL.

Referenced by fillExcelExport().

     {
         $value = $this->getValue();
 
         // TODO: Handle line-breaks for excel
         if (is_array($value) && !$this->getField()->getProperty(ilDclBaseFieldModel::PROP_URL)) {
             return $value['link'];
         } else {
             return $value;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPlainText()

ilDclTextRecordFieldModel::getPlainText ( )

Definition at line 72 of file class.ilDclTextRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, and ilDclBaseRecordFieldModel\getValue().

                                   : string
     {
         $value = $this->getValue();
 
         if (is_array($value)) {
             if ($value['title']) {
                 return $value['title'];
             }
 
             return $value['link'] ?? '';
         } else {
             if ($value) {
                 return $value;
             }
         }
         return '';
     }

Here is the call graph for this function:

◆ getValueFromExcel()

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

Parameters

ilExcel	$excel
int	$row
int	$col

Returns: array|int|string

Definition at line 111 of file class.ilDclTextRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, ilExcel\getCell(), ilDclBaseRecordFieldModel\getField(), and ilDclBaseFieldModel\PROP_URL.

     {
         $value = parent::getValueFromExcel($excel, $row, $col);
         if ($this->getField()->hasProperty(ilDclBaseFieldModel::PROP_URL)) {
             $title = '';
             if ($excel->getCell(1, $col + 1) == $this->getField()->getTitle() . '_title') {
                 $title = $excel->getCell($row, $col + 1);
             }
             $value = ['link' => $value, 'title' => $title];
         }
 
         if ($value) {
             return $value;
         }
         return "";
     }

Here is the call graph for this function:

◆ parseSortingValue()

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

Returns sortable value for the specific field-types.

Parameters

int | string $value

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

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), and ilDclBaseFieldModel\PROP_URL.

                                                                 : string
     {
         if ($this->getField()->getProperty(ilDclBaseFieldModel::PROP_URL)) {
             if (is_array($value)) {
                 return $value['title'] ?? $value['link'];
             } else {
                 return $value;
             }
         } else {
             return $value;
         }
     }

Here is the call graph for this function:

◆ parseValue()

ilDclTextRecordFieldModel::parseValue ( $value )

Parameters

int | string | array $value

Definition at line 131 of file class.ilDclTextRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), ilDclBaseFieldModel\PROP_TEXTAREA, and ilDclBaseFieldModel\PROP_URL.

     {
         if ($this->getField()->getProperty(ilDclBaseFieldModel::PROP_TEXTAREA)
             && !$this->getField()->getProperty(ilDclBaseFieldModel::PROP_URL)
         ) {
             return $value;
         }
 
         return $value;
     }

Here is the call graph for this function:

◆ setValueFromForm()

ilDclTextRecordFieldModel::setValueFromForm ( ilPropertyFormGUI $form )

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

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

                                                              : void
     {
         if ($this->getField()->hasProperty(ilDclBaseFieldModel::PROP_URL)) {
             $value = [
                 "link" => $form->getInput("field_" . $this->getField()->getId()),
                 "title" => $form->getInput("field_" . $this->getField()->getId() . '_title'),
             ];
         } else {
             $value = $form->getInput("field_" . $this->getField()->getId());
         }
         $this->setValue($value);
     }

Here is the call graph for this function:

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

components/ILIAS/DataCollection/classes/Fields/Text/class.ilDclTextRecordFieldModel.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addHiddenItemsToConfirmation()

◆ deserializeData()

◆ fillExcelExport()

◆ getExportValue()

◆ getPlainText()

◆ getValueFromExcel()

◆ parseSortingValue()

◆ parseValue()

◆ setValueFromForm()