ilDclSelectionFieldRepresentation Class Reference

Inheritance diagram for ilDclSelectionFieldRepresentation:

Collaboration diagram for ilDclSelectionFieldRepresentation:

Public Member Functions
	getInputField (ilPropertyFormGUI $form, ?int $record_id=null)
	addFilterInputFieldToTable (ilTable2GUI $table)
	getField ()
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')
	buildOptionsInput ()
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...

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

Detailed Description

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

Member Function Documentation

addFilterInputFieldToTable()

ilDclSelectionFieldRepresentation::addFilterInputFieldToTable

(

ilTable2GUI

$table

)

Definition at line 99 of file class.ilDclSelectionFieldRepresentation.php.

References ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_SELECT, ilDclSelectionOption\getAllForField(), getField(), ilDclBaseFieldRepresentation\getFilterInputFieldValue(), ILIAS\Survey\Mode\getId(), ILIAS\Repository\lng(), and ilDclBaseFieldRepresentation\setupFilterInputField().

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

        $options = ilDclSelectionOption::getAllForField((int) $this->getField()->getId());
        $array = ['' => $this->lng->txt('dcl_all_entries')];
        foreach ($options as $opt) {
            $array[$opt->getOptId()] = $opt->getValue();
        }

        $array['none'] = $this->lng->txt('dcl_no_entry');

        $input->setOptions($array);

        $this->setupFilterInputField($input);

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

Here is the call graph for this function:

buildFieldCreationInput()

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

protected

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

References buildOptionsInput(), ilDclBaseFieldRepresentation\getPropertyInputFieldId(), ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_UNIQUE, ilDclSelectionFieldModel\SELECTION_TYPE_COMBOBOX, ilDclSelectionFieldModel\SELECTION_TYPE_MULTI, ilDclSelectionFieldModel\SELECTION_TYPE_SINGLE, ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

                                                                                                 : ilRadioOption
    {
        $opt = parent::buildFieldCreationInput($dcl, $mode);

        $selection_options = $this->buildOptionsInput();
        $opt->addSubItem($selection_options);

        $selection_type = new ilRadioGroupInputGUI(
            $this->lng->txt('dcl_selection_type'),
            'prop_' . $this->field::PROP_SELECTION_TYPE
        );
        $selection_type->setRequired(true);

        $options = [
            ilDclSelectionFieldModel::SELECTION_TYPE_SINGLE,
            ilDclSelectionFieldModel::SELECTION_TYPE_COMBOBOX,
            ilDclSelectionFieldModel::SELECTION_TYPE_MULTI
        ];

        foreach ($options as $option) {
            $selection_type->addOption(new ilRadioOption($this->lng->txt('dcl_' . $option), $option));
        }

        $opt->addSubItem($selection_type);

        $prop_unique = new ilDclCheckboxInputGUI(
            $this->lng->txt('dcl_unique'),
            $this->getPropertyInputFieldId(ilDclBaseFieldModel::PROP_UNIQUE)
        );
        $prop_unique->setInfo($this->lng->txt('dcl_unique_desc'));
        $opt->addSubItem($prop_unique);

        return $opt;
    }

Here is the call graph for this function:

buildOptionsInput()

ilDclSelectionFieldRepresentation::buildOptionsInput ( )

abstractprotected

Referenced by buildFieldCreationInput(), and getField().

Here is the caller graph for this function:

getField()

ilDclSelectionFieldRepresentation::getField

(

)

Definition at line 123 of file class.ilDclSelectionFieldRepresentation.php.

References $field, and buildOptionsInput().

Referenced by addFilterInputFieldToTable(), and getInputField().

                              : ilDclSelectionFieldModel
    {
        return $this->field;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInputField()

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

Definition at line 63 of file class.ilDclSelectionFieldRepresentation.php.

References ilDclBaseFieldRepresentation\$user, ilDclSelectionOption\getAllForField(), getField(), ILIAS\Survey\Mode\getId(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ILIAS\Repository\lng(), ilDclSelectionFieldModel\SELECTION_TYPE_COMBOBOX, ilDclSelectionFieldModel\SELECTION_TYPE_MULTI, ilDclSelectionFieldModel\SELECTION_TYPE_SINGLE, and ilDclBaseFieldRepresentation\setupInputField().

                                                                                  : ilFormPropertyGUI
    {
        $options = [];
        foreach (ilDclSelectionOption::getAllForField((int) $this->getField()->getId()) as $opt) {
            $options[$opt->getOptId()] = $this->getField()->personalizeOptionValue($opt->getValue(), $this->user);
        }
        switch ($this->getField()->getProperty($this->field::PROP_SELECTION_TYPE)) {
            case ilDclSelectionFieldModel::SELECTION_TYPE_MULTI:
                $input = new ilMultiSelectInputGUI(
                    $this->getField()->getTitle(),
                    'field_' . $this->getField()->getId()
                );
                $input->setWidth(100);
                $input->setWidthUnit('%');
                $input->setHeight(32 * min(5, max(1, count($options))));

                $input->setOptions($options);
                break;
            case ilDclSelectionFieldModel::SELECTION_TYPE_COMBOBOX:
                $input = new ilSelectInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
                $input->setOptions(["" => $this->lng->txt('dcl_please_select')] + $options);
                break;
            case ilDclSelectionFieldModel::SELECTION_TYPE_SINGLE:
            default:
                $input = new ilRadioGroupInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
                foreach ($options as $key => $opt) {
                    $input->addOption(new ilRadioOption($opt, (string) $key));
                }
                $input->setValue((string) array_key_first($options));
                break;
        }
        $this->setupInputField($input, $this->getField());

        return $input;
    }

Here is the call graph for this function:

Field Documentation

$field

ilDclBaseFieldModel ilDclSelectionFieldRepresentation::$field

protected

Definition at line 26 of file class.ilDclSelectionFieldRepresentation.php.

Referenced by getField().

---

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

• components/ILIAS/DataCollection/classes/Fields/Selection/class.ilDclSelectionFieldRepresentation.php