Inheritance diagram for ilDataCollectionRecordField:

Collaboration diagram for ilDataCollectionRecordField:

Public Member Functions
	__construct (ilDataCollectionRecord $record, ilDataCollectionField $field)

	doUpdate ()
	Update object in database. More...

	delete ()
	Delete record field in database. More...

	getValue ()

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

	setValueFromForm (&$form)

	getValueFromExcel ($excel, $row, $col)

	fillFormInput (&$form)

	getExportValue ()

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

	getPlainText ()

	getHTML ($link=true)

	getSortingValue ($link=true)

	getSingleHTML ()

	getField ()

	getId ()

	getRecord ()

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

	doCreate ()
	Creates an Id and a database entry. More...

	getFormInput ()

	loadValue ()
	Load the value. More...

Protected Attributes
	$id

	$field

	$record

	$value

	$user

	$ctrl

	$db

	$lng

Detailed Description

Class ilDataCollectionField.

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

Constructor & Destructor Documentation

◆ __construct()

ilDataCollectionRecordField::__construct	(	ilDataCollectionRecord	$record,
		ilDataCollectionField	$field
	)

Parameters

ilDataCollectionRecord	$record
ilDataCollectionField	$field

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

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

                                                                                                   {
                 global $ilCtrl, $ilUser, $ilDB, $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

◆ delete()

ilDataCollectionRecordField::delete ( )

Delete record field in database.

Definition at line 133 of file class.ilDataCollectionRecordField.php.

References $query.

                                  {
                 $datatype = $this->field->getDatatype();
                 $query = "DELETE FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_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);
         }

◆ doCreate()

ilDataCollectionRecordField::doCreate ( )

protected

Creates an Id and a database entry.

Definition at line 94 of file class.ilDataCollectionRecordField.php.

References $id, and $query.

Referenced by doRead(), and 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->record->getId(), "integer") . ", " . $this->db->quote($this->field->getId(), "text") . ")";
                 $this->db->manipulate($query);
                 $this->id = $id;
         }

Here is the caller graph for this function:

◆ doRead()

ilDataCollectionRecordField::doRead ( )

protected

Read object data from database.

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

References $query, doCreate(), and loadValue().

Referenced by __construct().

                                     {
                 if(!$this->record->getId())
                         return;
 
                 $query = "SELECT * FROM il_dcl_record_field WHERE field_id = " . $this->db->quote($this->field->getId(), "integer") . " AND record_id = "
                         . $this->db->quote($this->record->getId(), "integer");
                 $set = $this->db->query($query);
                 $rec = $this->db->fetchAssoc($set);
                 $this->id = $rec['id'];
 
                 if ($this->id == null) {
                         $this->doCreate();
                 }
 
                 $this->loadValue();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilDataCollectionRecordField::doUpdate ( )

Update object in database.

Definition at line 106 of file class.ilDataCollectionRecordField.php.

References $query, $value, and doCreate().

                                    {
                 //$this->loadValue(); //Removed Mantis #0011799
                 if (!$this->id) {
                         $this->doCreate();
                 }
                 $datatype = $this->field->getDatatype();
                 $query = "DELETE FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_value WHERE record_field_id = "
                         . $this->db->quote($this->id, "integer");
                 $this->db->manipulate($query);
                 $next_id = $this->db->nextId("il_dcl_stloc" . $datatype->getStorageLocation() . "_value");
 
                 // This is a workaround to ensure that date values in stloc3 are never stored as NULL, which is not allowed
                 if ($datatype->getStorageLocation() == 3 && (is_null($this->value) || empty($this->value))) {
                         $this->value = '0000-00-00 00:00:00';
                 }
 
                 $this->db->insert("il_dcl_stloc" . $datatype->getStorageLocation() . "_value", array(
                         "value" => array( $datatype->getDbType(), $this->value ),
                         "record_field_id " => array( "integer", $this->id ),
                         "id" => array( "integer", $next_id )
                 ));
         }

Here is the call graph for this function:

◆ fillExcelExport()

ilDataCollectionRecordField::fillExcelExport	(		$worksheet,
		&	$row,
		&	$col
	)

Parameters

$worksheet
$row
$col

Definition at line 243 of file class.ilDataCollectionRecordField.php.

References $row, and getExportValue().

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

Here is the call graph for this function:

◆ fillFormInput()

ilDataCollectionRecordField::fillFormInput ( & $form )

Parameters

$form ilPropertyFormGUI

Definition at line 213 of file class.ilDataCollectionRecordField.php.

References $value, and getFormInput().

                                               {
                 $value = $this->getFormInput();
                 $form->getItemByPostVar('field_'.$this->field->getId())->setValueByArray(array("field_".$this->field->getId() => $value));
         }

Here is the call graph for this function:

◆ getExportValue()

ilDataCollectionRecordField::getExportValue ( )

Returns: int|string

Definition at line 232 of file class.ilDataCollectionRecordField.php.

References getValue().

Referenced by fillExcelExport(), and getPlainText().

                                          {
                 $datatype = $this->field->getDatatype();
 
                 return $datatype->parseExportValue($this->getValue());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getField()

ilDataCollectionRecordField::getField ( )

Returns: ilDataCollectionField

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

References $field.

                                    {
                 return $this->field;
         }

Here is the caller graph for this function:

◆ getFormInput()

ilDataCollectionRecordField::getFormInput ( )

protected

Returns: mixed

Definition at line 222 of file class.ilDataCollectionRecordField.php.

References getValue().

Referenced by fillFormInput().

                                           {
                 $datatype = $this->field->getDatatype();
 
                 return $datatype->parseFormInput($this->getValue(), $this);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilDataCollectionRecordField::getHTML ( $link = true )

Returns: string

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

References getValue().

Referenced by ilDataCollectionReferenceField\__construct(), and getSingleHTML().

                                               {
                 $datatype = $this->field->getDatatype();
 
                 return $datatype->parseHTML($this->getValue(), $this, $link);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilDataCollectionRecordField::getId ( )

Returns: int

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

References $id.

Referenced by ilDataCollectionRatingField\delete(), ilDataCollectionRatingField\getExportValue(), ilDataCollectionRatingField\getHTML(), ilDataCollectionRatingField\getValue(), and ilDataCollectionDatatype\parseHTML().

                                 {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getPlainText()

ilDataCollectionRecordField::getPlainText ( )

Returns: mixed used for the sorting.

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

References getExportValue().

                                        {
                 return $this->getExportValue();
         }

Here is the call graph for this function:

◆ getRecord()

ilDataCollectionRecordField::getRecord ( )

Returns: ilDataCollectionRecord

Definition at line 323 of file class.ilDataCollectionRecordField.php.

References $record.

Referenced by ilDataCollectionRatingField\getExportValue(), ilDataCollectionRatingField\getHTML(), ilDataCollectionRatingField\getValue(), ilDataCollectionDatatype\parseHTML(), and ilDataCollectionDatatype\parseValue().

                                     {
                 return $this->record;
         }

Here is the caller graph for this function:

◆ getSingleHTML()

ilDataCollectionRecordField::getSingleHTML ( )

Returns: string This method is used in the view definition of a single record (detail view)

Definition at line 279 of file class.ilDataCollectionRecordField.php.

References getHTML().

                                         {
                 return $this->getHTML(false);
         }

Here is the call graph for this function:

◆ getSortingValue()

ilDataCollectionRecordField::getSortingValue ( $link = true )

Returns: string

Definition at line 269 of file class.ilDataCollectionRecordField.php.

References getValue().

                                                       {
                 $datatype = $this->field->getDatatype();
 
                 return $datatype->parseSortingValue($this->getValue(), $this, $link);
         }

Here is the call graph for this function:

◆ getValue()

ilDataCollectionRecordField::getValue ( )

Returns: string

Definition at line 147 of file class.ilDataCollectionRecordField.php.

References $value, and loadValue().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValueFromExcel()

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

Parameters

$excel
$row
$col

Returns: array|string

Definition at line 199 of file class.ilDataCollectionRecordField.php.

References $row, $value, and ilDataCollectionDatatype\INPUTFORMAT_DATETIME.

                                                               {
                 $value = $excel->val($row, $col);
                 if ($this->field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_DATETIME) {
                         $value = array(
                                 'date' => date('Y-m-d', strtotime($value)),
                                 'time' => '00:00:00',
                         );
                 }
                 return $value;
         }

◆ loadValue()

ilDataCollectionRecordField::loadValue ( )

protected

Load the value.

Definition at line 287 of file class.ilDataCollectionRecordField.php.

References $query, and ilDataCollectionDatatype\INPUTFORMAT_RATING.

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

                                        {
                 if ($this->value === NULL) {
                         $datatype = $this->field->getDatatype();
                         switch ($datatype->getId()) {
                                 case ilDataCollectionDatatype::INPUTFORMAT_RATING:
                                         return true;
                         }
                         $query = "SELECT * FROM il_dcl_stloc" . $datatype->getStorageLocation() . "_value WHERE record_field_id = "
                                 . $this->db->quote($this->id, "integer");
 
                         $set = $this->db->query($query);
                         $rec = $this->db->fetchAssoc($set);
                         $this->value = $rec['value'];
                 }
         }

Here is the caller graph for this function:

◆ setValue()

ilDataCollectionRecordField::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 160 of file class.ilDataCollectionRecordField.php.

References $value, ilDataCollectionDatatype\INPUTFORMAT_FILE, and loadValue().

Referenced by ilDataCollectionNReferenceFieldGUI\buildTemplate(), ilDataCollectionTextField\fillFormInput(), ilDataCollectionTextField\setValueFromForm(), and setValueFromForm().

                                                                 {
                 $this->loadValue();
                 if (! $omit_parsing) {
                         $tmp = $this->field->getDatatype()->parseValue($value, $this);
                         $old = $this->value;
                         //if parse value fails keep the old value
                         if ($tmp !== false) {
                                 $this->value = $tmp;
                                 //delete old file from filesystem
                                 // TODO Does not belong here, create separate class ilDataCollectionFileField and overwrite setValue method
                                 if ($old && $this->field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_FILE) {
 //                                      $this->record->deleteFile($old); // Removed due to #0018064
                                 }
                         }
                 } else {
                         $this->value = $value;
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueFromForm()

ilDataCollectionRecordField::setValueFromForm ( & $form )

Parameters

$form ilPropertyFormGUI

Definition at line 182 of file class.ilDataCollectionRecordField.php.

References $value, ilDataCollectionDatatype\INPUTFORMAT_FILE, ilDataCollectionDatatype\INPUTFORMAT_MOB, and setValue().

                                                  {
                 if (in_array($this->field->getDatatypeId(), array(ilDataCollectionDatatype::INPUTFORMAT_MOB, ilDataCollectionDatatype::INPUTFORMAT_FILE))
                         && $form->getItemByPostVar("field_" . $this->field->getId())->getDeletionFlag()
                 ) {
                         $value = - 1;
                 } else {
                         $value = $form->getInput("field_" . $this->field->getId());
                 }
                 $this->setValue($value);
         }