ilDclReferenceFieldRepresentation 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 ilDclReferenceFieldRepresentation:

Collaboration diagram for ilDclReferenceFieldRepresentation:

Public Member Functions
	getInputField (ilPropertyFormGUI $form, ?int $record_id=null)
	addFilterInputFieldToTable (ilTable2GUI $table)
	passThroughFilter (ilDclBaseRecordModel $record, $filter)
Public Member Functions inherited from ilDclBaseFieldRepresentation
	__construct (ilDclBaseFieldModel $field)
	addFilterInputFieldToTable (ilTable2GUI $table)
	Add filter input to TableGUI. More...
	passThroughFilter (ilDclBaseRecordModel $record, $filter)
	Checks if a filter affects a record. More...
	parseSortingValue (string $value, bool $link=true)
	getInputField (ilPropertyFormGUI $form, ?int $record_id=null)
	Returns field-input. More...
	addFieldCreationForm (ilSubEnabledFormPropertyGUI $form, ilObjDataCollection $dcl, string $mode="create")
	Adds the options for the field-types to the field-creation form. More...
	getPropertyInputFieldId (string $property)
	Return post-var for property-fields. More...
	getField ()
	Return BaseFieldModel. More...

Data Fields
const	REFERENCE_SEPARATOR = " -> "

Protected Member Functions
	buildFieldCreationInput (ilObjDataCollection $dcl, string $mode='create')
	Build the creation-input-field. More...
Protected Member Functions inherited from ilDclBaseFieldRepresentation
	setupFilterInputField (?ilTableFilterItem $input)
	Set basic settings for filter-input-gui. More...
	setupInputField (ilFormPropertyGUI $input, ilDclBaseFieldModel $field)
	Sets basic settings on field-input. More...
	getFilterInputFieldValue (ilTableFilterItem $input)
	buildFieldCreationInput (ilObjDataCollection $dcl, string $mode='create')
	Build the creation-input-field. More...

Additional Inherited Members
Protected Attributes inherited from ilDclBaseFieldRepresentation
ilDclBaseFieldModel	$field
ilLanguage	$lng
ilCtrl	$ctrl
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ilComponentRepository	$component_repository
ilComponentFactory	$component_factory

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

Member Function Documentation

addFilterInputFieldToTable()

ilDclReferenceFieldRepresentation::addFilterInputFieldToTable

(

ilTable2GUI

$table

)

Returns

string|array|null

Reimplemented from ilDclBaseFieldRepresentation.

Definition at line 115 of file class.ilDclReferenceFieldRepresentation.php.

    {
        $input = $table->addFilterItemByMetaType(
            "filter_" . $this->getField()->getId(),
            ilTable2GUI::FILTER_SELECT,
            false,
            $this->getField()->getId()
        );
        $ref_field_id = $this->getField()->getProperty(ilDclBaseFieldModel::PROP_REFERENCE);
        $ref_field = ilDclCache::getFieldCache($ref_field_id);
        $ref_table = ilDclCache::getTableCache($ref_field->getTableId());
        $options = [];
        foreach ($ref_table->getRecords() as $record) {
            $options[$record->getId()] = $record->getRecordFieldPlainText($ref_field_id);
        }
        // Sort by values ASC
        asort($options);
        $options = ['' => $this->lng->txt('dcl_all_entries')]
            + $options
            + ['none' => $this->lng->txt('dcl_no_entry')];
        $input->setOptions($options);
 
        $this->setupFilterInputField($input);
 
        return $this->getFilterInputFieldValue($input);
    }

References ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_SELECT, ilDclBaseFieldRepresentation\getField(), ilDclCache\getFieldCache(), ilDclBaseFieldRepresentation\getFilterInputFieldValue(), ILIAS\Survey\Mode\getId(), ilDclCache\getTableCache(), ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_REFERENCE, and ilDclBaseFieldRepresentation\setupFilterInputField().

Here is the call graph for this function:

buildFieldCreationInput()

ilDclReferenceFieldRepresentation::buildFieldCreationInput ( ilObjDataCollection  $dcl, string  $mode = 'create'  )

protected

Build the creation-input-field.

Reimplemented from ilDclBaseFieldRepresentation.

Definition at line 163 of file class.ilDclReferenceFieldRepresentation.php.

                                                                                                 : ilRadioOption
    {
        $opt = parent::buildFieldCreationInput($dcl, $mode);
 
        $options = [];
        // Get Tables
        $tables = $dcl->getTables();
        foreach ($tables as $table) {
            foreach ($table->getRecordFields() as $field) {
                //referencing references may lead to endless loops.
                if ($field->getDatatypeId() != ilDclDatatype::INPUTFORMAT_REFERENCE) {
                    $options[$field->getId()] = $table->getTitle() . self::REFERENCE_SEPARATOR . $field->getTitle();
                }
            }
        }
        $prop_table_selection = new ilSelectInputGUI(
            $this->lng->txt('dcl_reference_title'),
            'prop_' . ilDclBaseFieldModel::PROP_REFERENCE
        );
        $prop_table_selection->setOptions($options);
 
        $opt->addSubItem($prop_table_selection);
 
        $prop_ref_link = new ilDclCheckboxInputGUI(
            $this->lng->txt('dcl_reference_link'),
            'prop_' . ilDclBaseFieldModel::PROP_REFERENCE_LINK
        );
        $prop_ref_link->setInfo($this->lng->txt('dcl_reference_link_info'));
        $opt->addSubItem($prop_ref_link);
 
        $prop_multi_select = new ilDclCheckboxInputGUI(
            $this->lng->txt('dcl_multiple_selection'),
            'prop_' . ilDclBaseFieldModel::PROP_N_REFERENCE
        );
        $opt->addSubItem($prop_multi_select);
 
        return $opt;
    }

References ilDclBaseFieldRepresentation\$field, ilDclBaseFieldModel\getDatatypeId(), ilDclBaseFieldModel\getId(), ilObjDataCollection\getTables(), ilDclBaseFieldModel\getTitle(), ilDclDatatype\INPUTFORMAT_REFERENCE, ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_N_REFERENCE, ilDclBaseFieldModel\PROP_REFERENCE, and ilDclBaseFieldModel\PROP_REFERENCE_LINK.

Here is the call graph for this function:

getInputField()

ilDclReferenceFieldRepresentation::getInputField	(	ilPropertyFormGUI	$form,
		?int	$record_id = null
	)

Parameters

ilPropertyFormGUI	$form
int | null	$record_id

Returns

ilSelectInputGUI|ilMultiSelectInputGUI

Reimplemented from ilDclBaseFieldRepresentation.

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

                                                                                  : ilFormPropertyGUI
    {
        if (!$this->getField()->getProperty(ilDclBaseFieldModel::PROP_N_REFERENCE)) {
            $input = new ilSelectInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
        } else {
            $input = new ilMultiSelectInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
            $input->setWidth(100);
            $input->setWidthUnit('%');
        }
 
        $this->setupInputField($input, $this->getField());
 
        $fieldref = $this->getField()->getProperty(ilDclBaseFieldModel::PROP_REFERENCE);
 
        $reffield = ilDclCache::getFieldCache($fieldref);
        $options = [];
        if (!$this->getField()->getProperty(ilDclBaseFieldModel::PROP_N_REFERENCE)) {
            $options[""] = $this->lng->txt('dcl_please_select');
        }
        $reftable = ilDclCache::getTableCache($reffield->getTableId());
        foreach ($reftable->getRecords() as $record) {
            // If the referenced field is MOB or FILE, we display the filename in the dropdown
            switch ($reffield->getDatatypeId()) {
                case ilDclDatatype::INPUTFORMAT_FILE:
                    $field_value = $record->getRecordFieldValue($fieldref);
                    if ($field_value) {
                        $file_obj = new ilObjFile($field_value, false);
                        $options[$record->getId()] = $file_obj->getFileName();
                    }
                    break;
                case ilDclDatatype::INPUTFORMAT_MOB:
                    $media_obj = new ilObjMediaObject($record->getRecordFieldValue($fieldref));
                    $options[$record->getId()] = $media_obj->getTitle();
                    break;
                case ilDclDatatype::INPUTFORMAT_DATETIME:
                    $options[$record->getId()] = strtotime($record->getRecordFieldSingleHTML($fieldref));
                    // TT #0019091: options2 are the actual values, options the timestamp for sorting
                    $options2[$record->getId()] = $record->getRecordFieldSingleHTML($fieldref);
                    break;
                case ilDclDatatype::INPUTFORMAT_TEXT:
                    $value = $record->getRecordFieldValue($fieldref);
                    if ($record->getRecordField($fieldref)->getField()->hasProperty(ilDclBaseFieldModel::PROP_URL)) {
                        if (!is_array($value)) {
                            $value = ['title' => '', 'link' => $value];
                        }
                        $value = $value['title'] ?: $value['link'];
                    }
                    $options[$record->getId()] = $value;
                    break;
                case ilDclDatatype::INPUTFORMAT_ILIAS_REF:
                    $options[$record->getId()] = $record->getRecordFieldRepresentationValue($fieldref);
                    break;
                default:
                    $options[$record->getId()] = $record->getRecordFieldExportValue($fieldref);
                    break;
            }
        }
        asort($options, SORT_NATURAL | SORT_FLAG_CASE);
 
        // TT #0019091: restore the actual values after sorting with timestamp
        if ($reffield->getDatatypeId() == ilDclDatatype::INPUTFORMAT_DATETIME) {
            foreach ($options as $key => $opt) {
                if ($key != "") {
                    $options[$key] = $options2[$key];
                }
            }
            // the option 'please select' messes with the order, therefore we reset it
            unset($options[""]);
            $options = ["" => $this->lng->txt('dcl_please_select')] + $options;
        }
 
        $input->setOptions($options);
 
        $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
 
        if (ilObjDataCollectionAccess::hasPermissionToAddRecord($ref_id, $reftable->getId())) {
            $input->addCustomAttribute('data-ref="1"');
            $input->addCustomAttribute('data-ref-table-id="' . $reftable->getId() . '"');
            $input->addCustomAttribute('data-ref-field-id="' . $reffield->getId() . '"');
        }
 
        return $input;
    }

References ILIAS\LTI\ToolProvider\$key, $ref_id, ilDclBaseFieldRepresentation\getField(), ilDclCache\getFieldCache(), ILIAS\Survey\Mode\getId(), ilDclCache\getTableCache(), ilObjDataCollectionAccess\hasPermissionToAddRecord(), ILIAS\FileDelivery\http(), ilDclDatatype\INPUTFORMAT_DATETIME, ilDclDatatype\INPUTFORMAT_FILE, ilDclDatatype\INPUTFORMAT_ILIAS_REF, ilDclDatatype\INPUTFORMAT_MOB, ilDclDatatype\INPUTFORMAT_TEXT, ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_N_REFERENCE, ilDclBaseFieldModel\PROP_REFERENCE, ilDclBaseFieldModel\PROP_URL, ILIAS\Repository\refinery(), and ilDclBaseFieldRepresentation\setupInputField().

Here is the call graph for this function:

passThroughFilter()

ilDclReferenceFieldRepresentation::passThroughFilter	(	ilDclBaseRecordModel	$record,
			$filter
	)

Parameters

int

$filter

Reimplemented from ilDclBaseFieldRepresentation.

Definition at line 145 of file class.ilDclReferenceFieldRepresentation.php.

                                                                            : bool
    {
        $value = $record->getRecordFieldValue($this->getField()->getId());
 
        $pass = false;
        if ($filter && $this->getField()->getProperty(ilDclBaseFieldModel::PROP_N_REFERENCE) && is_array($value) && in_array(
            $filter,
            $value
        )) {
            $pass = true;
        }
        if (!$filter || $filter == $value) {
            $pass = true;
        }
 
        return $pass;
    }

References ilDclBaseFieldRepresentation\getField(), ILIAS\Survey\Mode\getId(), ilDclBaseRecordModel\getRecordFieldValue(), and ilDclBaseFieldModel\PROP_N_REFERENCE.

Here is the call graph for this function:

Field Documentation

REFERENCE_SEPARATOR

const ilDclReferenceFieldRepresentation::REFERENCE_SEPARATOR = " -> "

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

---

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

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