ilDataCollectionReferenceField Class Reference

Class ilDataCollectionField. More...

Inheritance diagram for ilDataCollectionReferenceField:

Collaboration diagram for ilDataCollectionReferenceField:

Public Member Functions
	__construct (ilDataCollectionRecord $record, ilDataCollectionField $field)
	getExportValue ()
	getValueFromExcel ($excel, $row, $col)
	getReferenceFromValue ($value)
Public Member Functions inherited from ilDataCollectionRecordField
	__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
	getLinkHTML ($link_name=NULL, $value)
Protected Member Functions inherited from ilDataCollectionRecordField
	doRead ()
	Read object data from database. More...
	doCreate ()
	Creates an Id and a database entry. More...
	getFormInput ()
	loadValue ()
	Load the value. More...

Protected Attributes
	$dcl_obj_id
	$properties = array()
Protected Attributes inherited from ilDataCollectionRecordField
	$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

Version

$Id:

Definition at line 23 of file class.ilDataCollectionReferenceField.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

ilDataCollectionRecord	$record
ilDataCollectionField	$field

Definition at line 39 of file class.ilDataCollectionReferenceField.php.

References $html, $ilDB, $query, ilDataCollectionRecordField\$value, ilDataCollectionRecordField\getField(), ilDataCollectionRecordField\getHTML(), getLinkHTML(), ilDataCollectionCache\getRecordCache(), ilDataCollectionCache\getTableCache(), ilDataCollectionRecordField\getValue(), and ilDataCollectionField\PROPERTYID_REFERENCE_LINK.

                                                                                                  {
                parent::__construct($record, $field);
                $dclTable = ilDataCollectionCache::getTableCache($this->getField()->getTableId());
                $this->dcl_obj_id = $dclTable->getCollectionObject()->getId();
                $this->properties = $this->field->getProperties();
        }

Here is the call graph for this function:

Member Function Documentation

getExportValue()

ilDataCollectionReferenceField::getExportValue

(

)

Returns

int|string

Definition at line 116 of file class.ilDataCollectionReferenceField.php.

References ilDataCollectionRecordField\getField(), ilDataCollectionCache\getRecordCache(), and ilDataCollectionRecordField\getValue().

                                         {
                if ($this->getValue()) {
                        $ref_rec = ilDataCollectionCache::getRecordCache($this->getValue());
                        $exp_value = $ref_rec->getRecordField($this->getField()->getFieldRef())->getExportValue();
                        if ($exp_value instanceof stdClass) {
                                return json_encode($exp_value);
                        }
                        return $exp_value;
                } else {
                        return "";
                }
        }

Here is the call graph for this function:

getLinkHTML()

ilDataCollectionReferenceField::getLinkHTML (   $link_name = NULL,   $value  )

protected

Parameters

null	$link_name
	$value

Returns

string

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

References $html, $ilCtrl, ilDataCollectionRecordField\$value, and ilDataCollectionCache\getRecordCache().

Referenced by __construct().

                                                                  {
                global $ilCtrl;

                if (!$value || $value == "-") {
                        return "";
                }
                $record_field = $this;
                $ref_record = ilDataCollectionCache::getRecordCache($value);
                if (!$link_name) {
                        $link_name = $ref_record->getRecordFieldHTML($record_field->getField()->getFieldRef());
                }
                $ilCtrl->setParameterByClass("ildatacollectionrecordviewgui", "record_id", $ref_record->getId());
                $html = "<a href='" . $ilCtrl->getLinkTargetByClass("ilDataCollectionRecordViewGUI", "renderRecord") . "&disable_paging=1'>" . $link_name
                        . "</a>";

                return $html;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getReferenceFromValue()

ilDataCollectionReferenceField::getReferenceFromValue

(

$value

)

Parameters

$field	ilDataCollectionField
$value

Returns

int

Definition at line 149 of file class.ilDataCollectionReferenceField.php.

References ilDataCollectionRecordField\$field, ilDataCollectionRecordField\$record, ilDataCollectionRecordField\$value, ilDataCollectionCache\getFieldCache(), ilDataCollectionCache\getTableCache(), and ilDataCollectionRecordField\getValue().

Referenced by ilDataCollectionNReferenceField\getReferencesFromString(), and getValueFromExcel().

                                                      {
                $field = ilDataCollectionCache::getFieldCache($this->field->getFieldRef());
                $table = ilDataCollectionCache::getTableCache($field->getTableId());
                $record_id = 0;
                foreach ($table->getRecords() as $record) {
                        $record_value = $record->getRecordField($field->getId())->getValue();
                        // in case of a url-field
                        if ($json = json_decode($record_value,true)) {
                                $record_value = array_shift($json);
                        }
                        if ($record_value == $value) {
                                $record_id = $record->getId();
                        }
                }

                return $record_id;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getValueFromExcel()

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

Definition at line 129 of file class.ilDataCollectionReferenceField.php.

References ilDataCollectionRecordField\$lng, $row, ilDataCollectionRecordField\$value, ilDataCollectionImporter\getExcelCharForInteger(), and getReferenceFromValue().

                                                             {
                global $lng;
                $value = $excel->val($row, $col);
                $old = $value;
                $value = $this->getReferenceFromValue($value);
                if (!$value) {
                        $warning = "(" . $col . ", " . ilDataCollectionImporter::getExcelCharForInteger($col) . ") " . $lng->txt("dcl_no_such_reference") . " "
                                . $old;
                        return array('warning' => $warning);
                }

                return $value;
        }

Here is the call graph for this function:

Field Documentation

$dcl_obj_id

ilDataCollectionReferenceField::$dcl_obj_id

protected

Definition at line 28 of file class.ilDataCollectionReferenceField.php.

$properties

ilDataCollectionReferenceField::$properties = array()

protected

Definition at line 32 of file class.ilDataCollectionReferenceField.php.

---

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

• Modules/DataCollection/classes/class.ilDataCollectionReferenceField.php