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

	getFormInput ()

	getExportValue ()

	getPlainText ()

	getHTML ($link=true)

	getSortingValue ($link=true)

	getSingleHTML ()

	getField ()

	getId ()

	getRecord ()

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

	doCreate ()
	Create object in database. More...

	loadValue ()
	Load the value. More...

Protected Attributes
	$id

	$field

	$record

	$value

	$lng

	$user

	$ctrl

	$db

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 $lng, $ilCtrl, $ilUser, $ilDB;
                 $this->record = $record;
                 $this->field = $field;
                 $this->lng = $lng;
                 $this->ctrl = $ilCtrl;
                 $this->user = $ilUser;
                 $this->db = $ilDB;
                 $this->doRead();
         }

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilDataCollectionRecordField::delete ( )

Delete record field in database.

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

Create object in database.

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

References $id, and $query.

Referenced by doRead().

                                       {
                 $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().

                                     {
                 $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 102 of file class.ilDataCollectionRecordField.php.

References $query, and $value.

                                    {
                 //$this->loadValue(); //Removed Mantis #0011799
                 $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 )
                 ));
         }

◆ getExportValue()

ilDataCollectionRecordField::getExportValue ( )

Returns: int|string

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

References getValue().

Referenced by 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 252 of file class.ilDataCollectionRecordField.php.

References $field.

Referenced by ilDataCollectionRatingField\__construct(), ilDataCollectionILIASRefField\__construct(), ilDataCollectionReferenceField\__construct(), ilDataCollectionRatingField\delete(), ilDataCollectionRatingField\getExportValue(), ilDataCollectionReferenceField\getExportValue(), ilDataCollectionNReferenceField\getExportValue(), ilDataCollectionRatingField\getHTML(), ilDataCollectionNReferenceField\getLinkHTML(), ilDataCollectionRatingField\getValue(), ilDataCollectionDatatype\parseFormInput(), ilDataCollectionDatatype\parseHTML(), ilDataCollectionDatatype\parseSortingValue(), and ilDataCollectionDatatype\parseValue().

                                    {
                 return $this->field;
         }

Here is the caller graph for this function:

◆ getFormInput()

ilDataCollectionRecordField::getFormInput ( )

Returns: mixed

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

References getValue().

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

Here is the call graph for this function:

◆ getHTML()

ilDataCollectionRecordField::getHTML ( $link = true )

Returns: string

Definition at line 204 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 260 of file class.ilDataCollectionRecordField.php.

References $id.

Referenced by ilDataCollectionRatingField\delete(), ilDataCollectionRatingField\getExportValue(), ilDataCollectionRatingField\getHTML(), ilDataCollectionNReferenceField\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 196 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 268 of file class.ilDataCollectionRecordField.php.

References $record.

Referenced by ilDataCollectionRatingField\getExportValue(), ilDataCollectionRatingField\getHTML(), ilDataCollectionNReferenceField\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 224 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 213 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 140 of file class.ilDataCollectionRecordField.php.

References $value, and loadValue().

Referenced by ilDataCollectionReferenceField\__construct(), ilDataCollectionNReferenceField\doUpdate(), ilDataCollectionILIASRefField\getActionLink(), ilDataCollectionILIASRefField\getExportValue(), ilDataCollectionReferenceField\getExportValue(), getExportValue(), ilDataCollectionNReferenceField\getExportValue(), getFormInput(), ilDataCollectionILIASRefField\getHTML(), ilDataCollectionNReferenceField\getHTML(), getHTML(), ilDataCollectionILIASRefField\getLinkHTML(), ilDataCollectionILIASRefField\getSingleHTML(), ilDataCollectionNReferenceField\getSingleHTML(), getSortingValue(), ilDataCollectionILIASRefField\getStatus(), and ilDataCollectionDatatype\parseValue().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadValue()

ilDataCollectionRecordField::loadValue ( )

protected

Load the value.

Definition at line 232 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 153 of file class.ilDataCollectionRecordField.php.

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

                                                                 {
                 $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 && $old != $this->value && $this->field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_FILE) {
                                         $this->record->deleteFile($old);
                                 }
                         }
                 } else {
                         $this->value = $value;
                 }
         }