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, $omit_parsing=false)
	Set value for record field. More...

	setValueFromForm ($form)

	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)

Protected Member Functions
	doRead ()
	Read object data from database. More...

	loadValue ()
	Load the value. More...

Protected Attributes
	$id

	$field

	$record

	$record_representation

	$field_representation

	$value

	$user

	$ctrl

	$db

	$lng

Detailed Description

Class ilDclBaseFieldModel.

Author: Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Marcel Raimann mr@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: $Id:

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilDclBaseRecordModel	$record
ilDclBaseFieldModel	$field

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

References $DIC, $field, $ilCtrl, $ilDB, $ilUser, $lng, $record, doRead(), and user().

                                                                                               {
                 global $DIC;
                 $ilCtrl = $DIC['ilCtrl'];
                 $ilUser = $DIC['ilUser'];
                 $ilDB = $DIC['ilDB'];
                 $lng = $DIC['lng'];
                 $this->record = $record;
                 $this->field = $field;
                 $this->ctrl = $ilCtrl;
                 $this->user = $ilUser;
                 $this->db = $ilDB;
                 $this->lng = $lng;
                 $this->doRead();
         }

Here is the call graph for this function:

Member Function Documentation

◆ addHiddenItemsToConfirmation()

ilDclBaseRecordFieldModel::addHiddenItemsToConfirmation ( ilConfirmationGUI & $confirmation )

Parameters

ilConfirmationGUI $confirmation

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

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

                                                                                        {;
                 if (!is_array($this->getValue())) {
                         $confirmation->addHiddenItem('field_'.$this->field->getId(), $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 365 of file class.ilDclBaseRecordFieldModel.php.

                                     {
 
         }

◆ cloneStructure()

ilDclBaseRecordFieldModel::cloneStructure ( ilDclBaseRecordFieldModel $old_record_field )

Parameters

ilDclBaseRecordFieldModel $old_record_field

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

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

                                                                                     {
                 $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 153 of file class.ilDclBaseRecordFieldModel.php.

References $query, and getField().

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

$value mixed

Returns: mixed

Definition at line 205 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 104 of file class.ilDclBaseRecordFieldModel.php.

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

Referenced by doUpdate().

                                    {
                 $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 87 of file class.ilDclBaseRecordFieldModel.php.

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

Referenced by __construct().

                                     {
                 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'];
                 
                 $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 116 of file class.ilDclBaseRecordFieldModel.php.

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

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

                                    {
                 //$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");
 
                         // This is a workaround to ensure that date values in stloc3 are never stored as NULL, which is not allowed
                         if ($storage_location == 3 && (is_null($this->value) || empty($this->value))) {
                                 $this->value = '0000-00-00 00:00:00';
                         }
 
                         $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,
		&	$row,
		&	$col
	)

Parameters

$worksheet
$row
$col

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

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

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

Here is the call graph for this function:

◆ getExportValue()

ilDclBaseRecordFieldModel::getExportValue ( )

Returns: int|string

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

References getValue(), and parseExportValue().

Referenced by fillExcelExport(), 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 ( )

Returns: ilDclBaseFieldModel

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

References $field.

                                    {
                 return $this->field;
         }

Here is the caller graph for this function:

◆ getFieldRepresentation()

ilDclBaseRecordFieldModel::getFieldRepresentation ( )

Returns: ilDclBaseFieldRepresentation

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

References $field_representation.

                                                  {
                 return $this->field_representation;
         }

◆ getId()

ilDclBaseRecordFieldModel::getId ( )

Returns: int

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

References $id.

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

                                 {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getPlainText()

ilDclBaseRecordFieldModel::getPlainText ( )

Returns: mixed used for the sorting.

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

References getExportValue().

                                        {
                 return $this->getExportValue();
         }

Here is the call graph for this function:

◆ getRecord()

ilDclBaseRecordFieldModel::getRecord ( )

Returns: ilDclBaseRecordModel

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

References $record.

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

                                     {
                 return $this->record;
         }

Here is the caller graph for this function:

◆ getRecordRepresentation()

ilDclBaseRecordFieldModel::getRecordRepresentation ( )

Returns: ilDclBaseRecordRepresentation

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

References $record_representation.

                                                   {
                 return $this->record_representation;
         }

◆ getSortingValue()

ilDclBaseRecordFieldModel::getSortingValue ( $link = true )

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

References getValue(), and parseSortingValue().

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

Here is the call graph for this function:

◆ getValue()

ilDclBaseRecordFieldModel::getValue ( )

Returns: string|array

Definition at line 171 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(), ilDclReferenceRecordFieldModel\getReferenceFromValue(), 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 181 of file class.ilDclBaseRecordFieldModel.php.

References getValue().

                                                     {
                 return $this->getValue();
         }

Here is the call graph for this function:

◆ getValueFromExcel()

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

Parameters

$excel
$row
$col

Returns: array|string

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

References $row, and $value.

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

◆ loadValue()

ilDclBaseRecordFieldModel::loadValue ( )

protected

Load the value.

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

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

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

                                        {
                 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']);
                                 $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 249 of file class.ilDclBaseRecordFieldModel.php.

References $value.

Referenced by getExportValue().

                                                  {
                 return $value;
         }

Here is the caller graph for this function:

◆ parseSortingValue()

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

Returns sortable value for the specific field-types.

Parameters

	$value
ilDclBaseRecordFieldModel	$record_field
bool \| true	$link

Returns: int|string

Definition at line 328 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

$value

Returns: int|string

Definition at line 272 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

$value mixed

Returns: mixed

Definition at line 191 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 ( $field_representation )

Parameters

ilDclBaseFieldRepresentation $field_representation

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

References $field_representation.

                                                                       {
                 $this->field_representation = $field_representation;
         }

◆ setRecordRepresentation()

ilDclBaseRecordFieldModel::setRecordRepresentation ( $record_representation )

Parameters

ilDclBaseRecordRepresentation $record_representation

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

References $record_representation.

                                                                         {
                 $this->record_representation = $record_representation;
         }

◆ setValue()

ilDclBaseRecordFieldModel::setValue	(	$value,
		$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 219 of file class.ilDclBaseRecordFieldModel.php.

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

Referenced by ilDclReferenceRecordFieldModel\afterClone(), ilDclMobRecordFieldModel\afterClone(), ilDclNReferenceFieldGUI\buildTemplate(), cloneStructure(), ilDclTextRecordFieldModel\setValueFromForm(), ilDclMobRecordFieldModel\setValueFromForm(), and setValueFromForm().

                                                                 {
                 $this->loadValue();
                 if (! $omit_parsing) {
                         $tmp = $this->parseValue($value, $this);
                         $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 ( $form )

Parameters

$form ilPropertyFormGUI

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

References $value, getField(), getId(), and setValue().

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