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

Collaboration diagram for ilDclCopyFieldRepresentation:

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

Protected Member Functions
	buildFieldCreationInput (ilObjDataCollection $dcl, string $mode='create')
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...

Private Attributes
const	VALID_TYPES

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

Member Function Documentation

addFilterInputFieldToTable()

ilDclCopyFieldRepresentation::addFilterInputFieldToTable

(

ilTable2GUI

$table

)

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

References ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_TEXT, ilDclBaseFieldRepresentation\getField(), ilDclBaseFieldRepresentation\getFilterInputFieldValue(), ILIAS\Survey\Mode\getId(), and ilDclBaseFieldRepresentation\setupFilterInputField().

    {
        $input = $table->addFilterItemByMetaType(
            "filter_" . $this->getField()->getId(),
            ilTable2GUI::FILTER_TEXT,
            false,
            $this->getField()->getId()
        );
        $input->setSubmitFormOnEnter(true);

        $this->setupFilterInputField($input);

        return $this->getFilterInputFieldValue($input);
    }

Here is the call graph for this function:

buildFieldCreationInput()

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

protected

Definition at line 100 of file class.ilDclCopyFieldRepresentation.php.

References ilDclBaseFieldRepresentation\$field, ilSubEnabledFormPropertyGUI\addSubItem(), ilDclBaseFieldModel\getDatatypeId(), ilDclBaseFieldRepresentation\getField(), ilDclBaseFieldModel\getId(), ilObjDataCollection\getTables(), ilDclBaseFieldModel\getTitle(), ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_N_REFERENCE, and ilDclBaseFieldModel\PROP_REFERENCE.

                                                                                                 : ilRadioOption
    {
        $datetype_title = $this->getField()->getPresentationTitle();
        $opt = new ilRadioOption($this->getField()->getPresentationTitle(), $this->getField()->getDatatypeId());
        $opt->setInfo($this->getField()->getPresentationDescription());

        $options = [];
        $tables = $dcl->getTables();
        foreach ($tables as $table) {
            foreach ($table->getRecordFields() as $field) {
                if (in_array($field->getDatatypeId(), self::VALID_TYPES)) {
                    $options[$field->getId()] = $table->getTitle() . ' -> ' . $field->getTitle();
                }
            }
        }

        $prop_table_selection = new ilSelectInputGUI(
            $this->lng->txt('dcl_copy_title'),
            'prop_' . ilDclBaseFieldModel::PROP_REFERENCE
        );
        $prop_table_selection->setOptions($options);
        $opt->addSubItem($prop_table_selection);

        $prop_multi_select = new ilDclCheckboxInputGUI(
            $this->lng->txt('dcl_multiple_selection'),
            'prop_' . ilDclBaseFieldModel::PROP_N_REFERENCE
        );
        $opt->addSubItem($prop_multi_select);

        return $opt;
    }

Here is the call graph for this function:

getInputField()

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

Returns

ilSelectInputGUI|ilMultiSelectInputGUI

Definition at line 31 of file class.ilDclCopyFieldRepresentation.php.

References ilDclBaseFieldRepresentation\getField(), ilDclCache\getFieldCache(), ILIAS\Survey\Mode\getId(), ilDclCache\getRecordCache(), ilDclCache\getTableCache(), ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_N_REFERENCE, ilDclBaseFieldModel\PROP_REFERENCE, and ilDclBaseFieldRepresentation\setupInputField().

                                                                                  : ilFormPropertyGUI
    {
        if ($this->getField()->getProperty(ilDclBaseFieldModel::PROP_N_REFERENCE)) {
            $input = new ilMultiSelectInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
        } else {
            $input = new ilSelectInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
        }

        $this->setupInputField($input, $this->getField());

        $options = [];
        if (!$this->getField()->getProperty(ilDclBaseFieldModel::PROP_N_REFERENCE)) {
            $options[''] = $this->lng->txt('dcl_please_select');
        }

        $value = null;
        $copy_id = $this->getField()->getProperty(ilDclBaseFieldModel::PROP_REFERENCE);
        $copy_field = ilDclCache::getFieldCache($copy_id);
        if ($copy_field->getTableId() !== 0) {
            $copy_table = ilDclCache::getTableCache($copy_field->getTableId());
            foreach ($copy_table->getRecords() as $record) {
                $option = $record->getRecordField($copy_field->getId())->getPlainText();
                if (!in_array($option, $options)) {
                    $options[$option] = $option;
                }
            }
        } else {
            $input->setAlert($this->lng->txt('dcl_origin_not_found'));
        }

        if ($record_id !== null) {
            $value = ilDclCache::getRecordCache($record_id)->getRecordFieldValue($this->getField()->getId());
            if ($value !== '' && !array_key_exists($value, $options)) {
                $options[$value] = $value . ' ' . $this->lng->txt('dcl_deprecated_copy');
            }
        }

        $input->setOptions($options);

        return $input;
    }

Here is the call graph for this function:

passThroughFilter()

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

Definition at line 88 of file class.ilDclCopyFieldRepresentation.php.

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

                                                                            : bool
    {
        $pass = parent::passThroughFilter($record, $filter);

        $value = $record->getRecordFieldValue($this->getField()->getId());
        if (!$filter || strpos(strtolower($value), strtolower($filter)) !== false) {
            $pass = true;
        }

        return $pass;
    }

Here is the call graph for this function:

Field Documentation

VALID_TYPES

const ilDclCopyFieldRepresentation::VALID_TYPES

private

Initial value:

= [
        ilDclDatatype::INPUTFORMAT_TEXT,
        ilDclDatatype::INPUTFORMAT_NUMBER,
        ilDclDatatype::INPUTFORMAT_BOOLEAN,
        ilDclDatatype::INPUTFORMAT_DATETIME,
    ]

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

---

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

• Modules/DataCollection/classes/Fields/Copy/class.ilDclCopyFieldRepresentation.php