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

Inheritance diagram for ilDclFormulaRecordFieldModel:

Collaboration diagram for ilDclFormulaRecordFieldModel:

Public Member Functions
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)

	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)

	setValue ($value, bool $omit_parsing=false)
	Set value for record field. More...

	doUpdate ()
	Do nothing, value is runtime only and not stored in DB. More...

	delete ()
	Do nothing, value is runtime only and not stored in DB. More...

	getFormInput ()

	getHTML ()

	getExportValue ()

	getValue ()

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 ()
	Do nothing, value is runtime only and not stored in DB. More...

	doRead ()
	Do nothing, value is runtime only and not stored in DB. More...

	parse ()
	Parse expression. More...

	doRead ()
	Read object data from database. More...

	loadValue ()
	Load the value. More...

Protected Attributes
string	$expression = ''

string	$parsed_value = ''

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.ilDclFormulaRecordFieldModel.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilDclBaseRecordModel	$record
ilDclBaseFieldModel	$field

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 24 of file class.ilDclFormulaRecordFieldModel.php.

    {
        parent::__construct($record, $field);
 
        $this->expression = (string) $this->getField()->getProperty(ilDclBaseFieldModel::PROP_FORMULA_EXPRESSION);
    }

References ilDclBaseRecordFieldModel\$field, ilDclBaseRecordFieldModel\$record, ILIAS\GlobalScreen\Provider\__construct(), ilDclBaseRecordFieldModel\getField(), and ilDclBaseFieldModel\PROP_FORMULA_EXPRESSION.

Here is the call graph for this function:

Member Function Documentation

◆ addHiddenItemsToConfirmation()

ilDclFormulaRecordFieldModel::addHiddenItemsToConfirmation ( ilConfirmationGUI $confirmation )

Parameters

ilConfirmationGUI $confirmation

Reimplemented from ilDclBaseRecordFieldModel.

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

                                                                                 : void
    {
    }

◆ delete()

ilDclFormulaRecordFieldModel::delete ( )

Do nothing, value is runtime only and not stored in DB.

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 69 of file class.ilDclFormulaRecordFieldModel.php.

                            : void
    {
    }

◆ doRead()

ilDclFormulaRecordFieldModel::doRead ( )

protected

Do nothing, value is runtime only and not stored in DB.

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 62 of file class.ilDclFormulaRecordFieldModel.php.

                               : void
    {
    }

◆ doUpdate()

ilDclFormulaRecordFieldModel::doUpdate ( )

Do nothing, value is runtime only and not stored in DB.

Reimplemented from ilDclBaseRecordFieldModel.

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

                              : void
    {
    }

◆ getExportValue()

ilDclFormulaRecordFieldModel::getExportValue ( )

Returns: int|string

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 83 of file class.ilDclFormulaRecordFieldModel.php.

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

References parse().

Here is the call graph for this function:

◆ getFormInput()

ilDclFormulaRecordFieldModel::getFormInput ( )

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

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

References parse().

Here is the call graph for this function:

◆ getHTML()

ilDclFormulaRecordFieldModel::getHTML ( )

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

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

References parse().

Here is the call graph for this function:

◆ getValue()

ilDclFormulaRecordFieldModel::getValue ( )

Returns: string|array

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 88 of file class.ilDclFormulaRecordFieldModel.php.

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

References parse().

Here is the call graph for this function:

◆ loadValue()

ilDclFormulaRecordFieldModel::loadValue ( )

protected

Do nothing, value is runtime only and not stored in DB.

Reimplemented from ilDclBaseRecordFieldModel.

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

                                  : void
    {
    }

◆ parse()

ilDclFormulaRecordFieldModel::parse ( )

protected

Parse expression.

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

                              : string
    {
        if (!$this->parsed_value && $this->expression) {
            $parser = new ilDclExpressionParser($this->expression, $this->getRecord(), $this->getField());
            try {
                $this->parsed_value = $parser->parse();
            } catch (ilException $e) {
                return $this->lng->txt('dcl_error_parsing_expression') . ' (' . $e->getMessage() . ')';
            }
        }
 
        return $this->parsed_value;
    }

References Vendor\Package\$e, $parsed_value, ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getRecord(), and ILIAS\Repository\lng().

Referenced by getExportValue(), getFormInput(), getHTML(), and getValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue()

ilDclFormulaRecordFieldModel::setValue	(		$value,
		bool	$omit_parsing = `false`
	)

Set value for record field.

Parameters

int \| float	$value
bool	$omit_parsing	If true, does not parse the value and stores it in the given format

Reimplemented from ilDclBaseRecordFieldModel.

Definition at line 47 of file class.ilDclFormulaRecordFieldModel.php.

                                                                : void
    {
        unset($value);
    }

References ilDclBaseRecordFieldModel\$value.

Field Documentation

◆ $expression

string ilDclFormulaRecordFieldModel::$expression = ''

protected

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

◆ $parsed_value

string ilDclFormulaRecordFieldModel::$parsed_value = ''

protected

Definition at line 22 of file class.ilDclFormulaRecordFieldModel.php.

Referenced by parse().

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

Modules/DataCollection/classes/Fields/Formula/class.ilDclFormulaRecordFieldModel.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addHiddenItemsToConfirmation()

◆ delete()

◆ doRead()

◆ doUpdate()

◆ getExportValue()

◆ getFormInput()

◆ getHTML()

◆ getValue()

◆ loadValue()

◆ parse()

◆ setValue()

Field Documentation

◆ $expression

◆ $parsed_value