Skip to content

DataCollection: fix dropdown sortation of ref fields for ILIAS 10 #10838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iszmais merged 1 commit into from
Jan 8, 2026
Merged

DataCollection: fix dropdown sortation of ref fields for ILIAS 10 #10838

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 43 additions & 57 deletions ...ILIAS/DataCollection/classes/Fields/Reference/class.ilDclReferenceFieldRepresentation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,7 @@ class ilDclReferenceFieldRepresentation extends ilDclBaseFieldRepresentation
{
public const REFERENCE_SEPARATOR = " -> ";

/**
* @param ilPropertyFormGUI $form
* @param int|null $record_id
* @return ilSelectInputGUI|ilMultiSelectInputGUI
*/
public function getInputField(ilPropertyFormGUI $form, ?int $record_id = null): ilFormPropertyGUI
public function getInputField(ilPropertyFormGUI $form, ?int $record_id = null): ilSelectInputGUI|ilMultiSelectInputGUI
{
if ($this->getField()->getProperty(ilDclBaseFieldModel::PROP_N_REFERENCE)) {
$input = new ilMultiSelectInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
Expand All @@ -39,11 +34,50 @@ public function getInputField(ilPropertyFormGUI $form, ?int $record_id = null):

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

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

$input->setOptions($options);
if ($input instanceof ilMultiSelectInputGUI) {
$input->setHeight(32 * min(5, max(1, count($options))));
}

$ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());

$fieldref = (int) $this->getField()->getProperty(ilDclBaseFieldModel::PROP_REFERENCE);
$reffield = ilDclCache::getFieldCache($fieldref);
if (ilObjDataCollectionAccess::hasPermissionToAddRecord($ref_id, $reffield->getTableId())) {
$input->addCustomAttribute('data-ref="1"');
$input->addCustomAttribute('data-ref-table-id="' . $reffield->getTableId() . '"');
$input->addCustomAttribute('data-ref-field-id="' . $reffield->getId() . '"');
}

return $input;
}

public function addFilterInputFieldToTable(ilTable2GUI $table): array|string|null
{
$input = $table->addFilterItemByMetaType(
"filter_" . $this->getField()->getId(),
ilTable2GUI::FILTER_SELECT,
false,
$this->getField()->getId()
);
$options = ['' => $this->lng->txt('dcl_all_entries')]
+ $this->getSortedRecords()
+ ['none' => $this->lng->txt('dcl_no_entry')];
$input->setOptions($options);

$this->setupFilterInputField($input);

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

protected function getSortedRecords(): array
{
$options = [];
$fieldref = (int) $this->getField()->getProperty(ilDclBaseFieldModel::PROP_REFERENCE);
$reffield = ilDclCache::getFieldCache($fieldref);
$reftable = ilDclCache::getTableCache($reffield->getTableId());
Expand Down Expand Up @@ -85,63 +119,15 @@ public function getInputField(ilPropertyFormGUI $form, ?int $record_id = null):
}
asort($options, SORT_NATURAL | SORT_FLAG_CASE);

// TT #0019091: restore the actual values after sorting with timestamp
if ($reffield->getDatatypeId() === ilDclDatatype::INPUTFORMAT_DATE) {
foreach ($options as $key => $opt) {
if ($key != "" && isset($options2) && is_array($options2)) {
$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);
if ($input instanceof ilMultiSelectInputGUI) {
$input->setHeight(32 * min(5, max(1, count($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;
}

/**
* @return string|array|null
*/
public function addFilterInputFieldToTable(ilTable2GUI $table)
{
$input = $table->addFilterItemByMetaType(
"filter_" . $this->getField()->getId(),
ilTable2GUI::FILTER_SELECT,
false,
$this->getField()->getId()
);
$ref_field_id = (int) $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->getRecordField($ref_field_id)->getPlainText();
}
// 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);
return $options;
}

/**
Expand Down