Class ilDclTextRecordFieldModel. More...

Inheritance diagram for ilDclTextRecordFieldModel:

Collaboration diagram for ilDclTextRecordFieldModel:

Public Member Functions
	setValueFromForm ($form)

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

	addHiddenItemsToConfirmation (ilConfirmationGUI &$confirmation)

	getPlainText ()

	getExportValue ()

	getValueFromExcel ($excel, $row, $col)

	parseValue ($value)
	Function to parse incoming data from form input value $value. More...

	parseSortingValue ($value, $link=true)
	Returns sortable value for the specific field-types. 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, $omit_parsing=false)
	Set value for record field. More...

	setValueFromForm ($form)

	getFormulaValue ()

	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...

	getValueFromExcel ($excel, $row, $col)

	parseValue ($value)
	Function to parse incoming data from form input value $value. More...

	getExportValue ()

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

	getPlainText ()

	getSortingValue ($link=true)

	addHiddenItemsToConfirmation (ilConfirmationGUI &$confirmation)

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

	cloneStructure (ilDclBaseRecordFieldModel $old_record_field)

	afterClone ()

	getField ()

	getId ()

	getRecord ()

	getRecordRepresentation ()

	setRecordRepresentation ($record_representation)

	getFieldRepresentation ()

	setFieldRepresentation ($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
	$id

	$field

	$record

	$record_representation

	$field_representation

	$value

	$user

	$ctrl

	$db

	$lng

Detailed Description

Class ilDclTextRecordFieldModel.

Author: Theodor Truffer tt@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

◆ addHiddenItemsToConfirmation()

ilDclTextRecordFieldModel::addHiddenItemsToConfirmation ( ilConfirmationGUI & $confirmation )

Parameters

ilConfirmationGUI $confirmation

Reimplemented from ilDclBaseRecordFieldModel.

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

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

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

Here is the call graph for this function:

◆ fillExcelExport()

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

Parameters

$worksheet
$row
$col

Reimplemented from ilDclBaseRecordFieldModel.

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

    {
        $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++;
        }
    }

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

Here is the call graph for this function:

◆ getExportValue()

ilDclTextRecordFieldModel::getExportValue ( )

Returns: mixed|string

Reimplemented from ilDclBaseRecordFieldModel.

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

    {
        $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;
        }
    }

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

Referenced by fillExcelExport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPlainText()

ilDclTextRecordFieldModel::getPlainText ( )

Returns: string

Reimplemented from ilDclBaseRecordFieldModel.

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

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

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

Here is the call graph for this function:

◆ getValueFromExcel()

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

Parameters

$excel
$row
$col

Returns: array|string

Reimplemented from ilDclBaseRecordFieldModel.

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

    {
        $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 = array('link' => $value, 'title' => $title);
        }
 
        return $value;
    }

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

Here is the call graph for this function:

◆ parseSortingValue()

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

Returns sortable value for the specific field-types.

Parameters

	$value
ilDclBaseRecordFieldModel	$record_field
bool \| true	$link

Returns: int|string

Reimplemented from ilDclBaseRecordFieldModel.

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

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

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

Here is the call graph for this function:

◆ parseValue()

ilDclTextRecordFieldModel::parseValue ( $value )

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

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

Parameters

$value

Returns: int|string

Reimplemented from ilDclBaseRecordFieldModel.

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

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

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

Here is the call graph for this function:

◆ setValueFromForm()

ilDclTextRecordFieldModel::setValueFromForm ( $form )

Parameters

$form ilPropertyFormGUI

Reimplemented from ilDclBaseRecordFieldModel.

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

    {
        if ($this->getField()->hasProperty(ilDclBaseFieldModel::PROP_URL)) {
            $value = array(
                "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);
    }

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

Here is the call graph for this function:

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

Modules/DataCollection/classes/Fields/Text/class.ilDclTextRecordFieldModel.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addHiddenItemsToConfirmation()

◆ fillExcelExport()

◆ getExportValue()

◆ getPlainText()

◆ getValueFromExcel()

◆ parseSortingValue()

◆ parseValue()

◆ setValueFromForm()