ilDclReferenceRecordRepresentation Class Reference

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

Inheritance diagram for ilDclReferenceRecordRepresentation:

Collaboration diagram for ilDclReferenceRecordRepresentation:

Public Member Functions
	getHTML (bool $link=true, array $options=[])
	Outputs html of a certain field. More...
	parseFormInput ($value)
	function parses stored value to the variable needed to fill into the form for editing. More...
Public Member Functions inherited from ilDclBaseRecordRepresentation
	__construct (ilDclBaseRecordFieldModel $record_field)
	getFormGUI (ilPropertyFormGUI $formGUI)
	parseFormInput ($value)
	function parses stored value to the variable needed to fill into the form for editing. More...
	fillFormInput (ilPropertyFormGUI $form)
	Fills the form with the value of a record. More...
	getHTML (bool $link=true, array $options=[])
	Outputs html of a certain field. More...
	getSingleHTML (?array $options=null, bool $link=true)
	Returns data for single record view. More...
	getConfirmationHTML ()
	Returns data for confirmation list When returning false, attribute is ignored in list. More...
	fillRow (ilTemplate $tpl)
	Fills row with record data. More...
	getRecordField ()
	Get Record Field. More...
	getField ()
	Getter shortcut for field. More...
	getRecord ()
	Getter shortcut for record. More...

Protected Member Functions
	getLinkHTML (ilDclBaseRecordModel $record, int $view)
Protected Member Functions inherited from ilDclBaseRecordRepresentation
	getFormInput ()
	Gets the value from from the record field. More...

Additional Inherited Members
Protected Attributes inherited from ilDclBaseRecordRepresentation
ilDclBaseRecordFieldModel	$record_field
ilLanguage	$lng
ilAccess	$access
ilCtrl	$ctrl
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ILIAS UI Renderer	$renderer
ilObjUser	$user

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

Member Function Documentation

getHTML()

ilDclReferenceRecordRepresentation::getHTML	(	bool	$link = true,
		array	$options = []
	)

Outputs html of a certain field.

Reimplemented from ilDclBaseRecordRepresentation.

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

                                                                   : string
    {
        $value = $this->getRecordField()->getValue();
        $record_field = $this->getRecordField();
 
        if (!$value || $value == "-") {
            return "";
        }
 
        if (!is_array($value)) {
            $value = [$value];
        }
 
        $items = [];
 
        foreach ($value as $k => $v) {
            $ref_record = ilDclCache::getRecordCache($v);
            if (!$ref_record->getId() || !$ref_record->getTableId() || !$record_field->getField() || !$record_field->getField()->getTableId()) {
                //the referenced record_field does not seem to exist.
                unset($value[$k]);
                $value = array_values($value); // resets the keys
                $record_field->setValue($value);
                $record_field->doUpdate();
                continue;
            } else {
                $field = $this->getRecordField()->getField();
                if ($field->getProperty(ilDclBaseFieldModel::PROP_REFERENCE_LINK)) {
                    $ref_table = $ref_record->getTable();
                    $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
                    if ($v !== null && $v !== '' && $v !== '-') {
                        $view = $ref_record->getTable()->getFirstTableViewId($ref_id, $this->user->getId(), true);
                        if ($view) {
                            $items[] = $this->getLinkHTML($ref_record, $view);
                            continue;
                        }
                    }
                }
                $items[] = $ref_record->getRecordFieldHTML($field->getProperty(ilDclBaseFieldModel::PROP_REFERENCE));
            }
        }
 
        return implode('<br>', $items);
    }

References ilDclBaseRecordRepresentation\$record_field, $ref_id, ilDclBaseRecordFieldModel\doUpdate(), ilDclBaseRecordFieldModel\getField(), getLinkHTML(), ilDclCache\getRecordCache(), ilDclBaseRecordRepresentation\getRecordField(), ILIAS\FileDelivery\http(), ilDclBaseFieldModel\PROP_REFERENCE, ilDclBaseFieldModel\PROP_REFERENCE_LINK, ILIAS\Repository\refinery(), ilDclBaseRecordFieldModel\setValue(), and ILIAS\Repository\user().

Here is the call graph for this function:

getLinkHTML()

ilDclReferenceRecordRepresentation::getLinkHTML ( ilDclBaseRecordModel  $record, int  $view  )

protected

Definition at line 65 of file class.ilDclReferenceRecordRepresentation.php.

                                                                           : string
    {
        $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "table_id", $record->getTableId());
        $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "record_id", $record->getId());
        $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, "tableview_id", $view);
        $html = $this->factory->link()->standard(
            $record->getRecordFieldValue($this->getField()->getProperty(ilDclBaseFieldModel::PROP_REFERENCE)),
            $this->ctrl->getLinkTargetByClass(
                ilDclDetailedViewGUI::class,
                "renderRecord"
            )
        );
 
        return $this->renderer->render($html);
    }

References ILIAS\Repository\ctrl(), ilDclBaseRecordModel\getId(), ilDclBaseRecordModel\getRecordFieldValue(), ilDclBaseRecordModel\getTableId(), and ilDclBaseFieldModel\PROP_REFERENCE.

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

parseFormInput()

ilDclReferenceRecordRepresentation::parseFormInput

(

$value

)

function parses stored value to the variable needed to fill into the form for editing.

Parameters

string | array

$value

Reimplemented from ilDclBaseRecordRepresentation.

Definition at line 85 of file class.ilDclReferenceRecordRepresentation.php.

    {
        if (!$value || $value == []) {
            return null;
        }
 
        return $value;
    }

---

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

• Modules/DataCollection/classes/Fields/Reference/class.ilDclReferenceRecordRepresentation.php