class.ilDclRecordListTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilDclRecordListTableGUI extends ilTable2GUI
{
    public const EXPORT_EXCEL_ASYNC = 10;
    protected ?object $parent_obj;
    protected ilDclTable $table;
    protected ?ilDclTableView $tableview;
    protected array $object_data;
    protected array $numeric_fields = [];
    protected array $filter = [];
    protected string $mode;
    protected int $userId;
    protected ilCtrl $ctrl;
    protected ilLanguage $lng;
    protected \ILIAS\DI\UIServices $ui;
    protected bool $page_active = false;

    public function __construct(
        ilDclRecordListGUI $a_parent_obj,
        string $a_parent_cmd,
        ilDclTable $table,
        int $tableview_id,
        string $mode = ilDclRecordListGUI::MODE_VIEW
    ) {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->userId = $DIC->user()->getId();
        $this->lng = $DIC->language();
        $this->ui = $DIC->ui();

        $this->tableview = ilDclTableView::find($tableview_id);
        $identifier = 'dcl_rl_' . $table->getId() . '_' . $tableview_id;
        $this->setPrefix($identifier);
        $this->setFormName($identifier);
        $this->setId($identifier);
        $page = new ilDclDetailedViewDefinitionGUI($this->tableview->getId());
        $this->page_active = $page->getPageObject()->isActive();

        parent::__construct($a_parent_obj, $a_parent_cmd);
        $this->table = $table;
        $this->parent_obj = $a_parent_obj;
        $this->setRowTemplate("tpl.record_list_row.html", "components/ILIAS/DataCollection");
        $this->mode = $mode;

        // Setup columns and sorting columns
        if ($this->mode == ilDclRecordListGUI::MODE_MANAGE) {
            // Add checkbox columns
            $this->addColumn("", "", "1", true);
            $this->setSelectAllCheckbox("record_ids[]");
            $this->addMultiCommand("confirmDeleteRecords", $this->lng->txt('dcl_delete_records'));
        }

        if ($this->page_active) {
            $this->addColumn("", "_front", '15px');
        }

        $this->numeric_fields = [];
        foreach ($this->tableview->getVisibleFields() as $field) {
            $title = $field->getTitle();
            $sort_field = ($field->getRecordQuerySortObject() != null) ? $field->getSortField() : '';

            if ($field->hasNumericSorting()) {
                $this->numeric_fields[] = $title;
            }
            $this->addColumn($title, $sort_field);

            if ($field->hasProperty(ilDclBaseFieldModel::PROP_LEARNING_PROGRESS)) {
                $this->addColumn($this->lng->txt("dcl_status"), "_status_" . $field->getTitle());
            }
        }
        $this->setTopCommands(true);
        $this->setEnableHeader(true);
        $this->setShowRowsSelector(true);
        $this->setEnableTitle(true);
        $this->setTitle($table->getTitle());
        $this->setDescription($this->tableview->getTitle());
        $this->setDefaultOrderDirection($this->table->getDefaultSortFieldOrder());
        // Set a default sorting?
        $default_sort_title = 'id';
        if ($fieldId = $this->table->getDefaultSortField()) {
            if (ilDclStandardField::_isStandardField($fieldId)) {
                foreach (ilDclStandardField::_getStandardFields($this->table->getId()) as $stdField) {
                    if ($stdField->getId() == $fieldId) {
                        $default_sort_title = $stdField->getTitle();
                        break;
                    }
                }
            } else {
                $default_sort_title = ilDclCache::getFieldCache((int) $fieldId)->getTitle();
            }
            $this->setDefaultOrderField($default_sort_title);
        }

        if (($this->table->getExportEnabled() || ilObjDataCollectionAccess::hasAccessToFields(
            $this->parent_obj->getRefId(),
            $this->table->getId()
        ))) {
            $this->setExportFormats([self::EXPORT_EXCEL, self::EXPORT_EXCEL_ASYNC]);
        }

        $this->ctrl->saveParameter($a_parent_obj, 'tableview_id');
        $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, "applyFilter"));
        $this->setStyle('table', $this->getStyle('table') . ' ' . 'dcl_record_list');
    }

    public function getFilter(): array
    {
        return $this->filter;
    }

    public function setRecordData(array $data): void
    {
        $this->object_data = $data;
        $this->buildData();
        $this->addActionRowIfNeeded();
    }

    protected function addActionRowIfNeeded(): void
    {
        if ($this->needsActionRow()) {
            $this->addColumn($this->lng->txt("actions"), "", "");
        }
    }

    public function numericOrdering(string $a_field): bool
    {
        return in_array($a_field, $this->numeric_fields);
    }

    private function buildData(): void
    {
        $data = [];
        foreach ($this->object_data as $record) {
            $record_data = [];
            $record_data["_front"] = null;
            $record_data['_record'] = $record;

            foreach ($this->tableview->getVisibleFields() as $field) {
                $title = $field->getTitle();
                $record_data[$title] = $record->getRecordFieldHTML($field->getId(), ['tableview_id' => $this->tableview->getId()]);

                // Additional column filled in ::fillRow() method, showing the learning progress
                if ($field->getProperty(ilDclBaseFieldModel::PROP_LEARNING_PROGRESS)) {
                    $record_data["_status_" . $title] = $this->getStatus($record, $field);
                }

                if ($field->getId() == 'comments') {
                    $record_data['n_comments'] = $record->getNrOfComments();
                }
            }

            $this->ctrl->setParameterByClass(ilDclFieldEditGUI::class, "record_id", $record->getId());
            $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", $this->tableview->getId());
            $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "record_id", $record->getId());
            $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "tableview_id", $this->tableview->getId());
            $this->ctrl->setParameterByClass(ilDclRecordEditGUI::class, "mode", $this->mode);

            $action_links = [];

            if ($this->page_active) {
                $record_data["_front"] = $this->ctrl->getLinkTargetByClass(ilDclDetailedViewGUI::class, 'renderRecord');
                $action_links[] = $this->ui->factory()->link()->standard(
                    $this->lng->txt('view'),
                    $this->ctrl->getLinkTargetByClass(ilDclDetailedViewGUI::class, 'renderRecord')
                );
            }

            if ($record->hasPermissionToEdit($this->parent_obj->getRefId())) {
                $action_links[] = $this->ui->factory()->link()->standard(
                    $this->lng->txt('edit'),
                    $this->ctrl->getLinkTargetByClass(ilDclRecordEditGUI::class, 'edit')
                );
            }

            if ($record->hasPermissionToDelete($this->parent_obj->getRefId())) {
                $action_links[] = $this->ui->factory()->link()->standard(
                    $this->lng->txt('delete'),
                    $this->ctrl->getLinkTargetByClass(ilDclRecordEditGUI::class, 'confirmDelete')
                );
            }

            if ($this->table->getPublicCommentsEnabled()) {
                $js_code = $this->getCommentJsLinkCode($record->getId());
                $action_links[] = $this->ui->factory()->button()->shy(
                    $this->lng->txt('dcl_comments'),
                    "#"
                )->withAdditionalOnLoadCode(function ($id) use ($js_code) {
                    return "document.getElementById('$id').addEventListener('click',function()
                        { 
                            $js_code
                        });";
                });
            }
            $action_dropdown = $this->ui->factory()->dropdown()->standard($action_links)
                                        ->withLabel($this->lng->txt("actions"));
            $record_data["_actions"] = $this->ui->renderer()->render($action_dropdown);

            $data[] = $record_data;
        }
        $this->setData($data);
    }

    protected function fillRow(array $a_set): void
    {
        $record_obj = $a_set['_record'];

        foreach ($this->tableview->getVisibleFields() as $field) {
            $title = $field->getTitle();
            $this->tpl->setCurrentBlock("field");
            $content = $a_set[$title];
            if ($content === false || $content === null) {
                $content = '';
            } // SW - This ensures to display also zeros in the table...

            $this->tpl->setVariable("CONTENT", $content);
            $this->tpl->parseCurrentBlock();

            if ($field->getProperty(ilDclBaseFieldModel::PROP_LEARNING_PROGRESS)) {
                $this->tpl->setCurrentBlock("field");
                $this->tpl->setVariable("CONTENT", $a_set["_status_" . $title]);
                $this->tpl->parseCurrentBlock();
            }
        }

        if ($a_set["_front"]) {
            $this->tpl->setCurrentBlock('view');
            $this->tpl->setVariable(
                "VIEW_DETAILS",
                $this->ui->renderer()->render($this->ui->factory()->symbol()->glyph()->enlarge($a_set["_front"]))
            );
            $this->tpl->parseCurrentBlock();
        }

        if (strlen($a_set["_actions"]) > 0) {
            $this->tpl->setCurrentBlock('actions');
            $this->tpl->setVariable("ACTIONS", $a_set["_actions"]);
            $this->tpl->parseCurrentBlock();
        }

        if ($this->mode == ilDclRecordListGUI::MODE_MANAGE) {
            if ($record_obj->hasPermissionToDelete($this->parent_obj->getRefId())) {
                $this->tpl->setCurrentBlock('mode_manage');
                $this->tpl->setVariable('RECORD_ID', $record_obj->getId());
                $this->tpl->parseCurrentBlock();
            } else {
                $this->tpl->touchBlock('mode_manage_no_owner');
            }
        }
    }

    protected function needsActionRow(): bool
    {
        if ($this->table->getPublicCommentsEnabled() || $this->page_active) {
            return true;
        }

        foreach ($this->object_data as $record) {
            if ($record->hasPermissionToEdit($this->parent_obj->getRefId()) ||
                $record->hasPermissionToDelete($this->parent_obj->getRefId())) {
                return true;
            }
        }

        return false;
    }

    protected function getStatus(ilDclBaseRecordModel $record, ilDclBaseFieldModel $field): string
    {
        $record_field = ilDclCache::getRecordFieldCache($record, $field);
        $return = "";
        if ($status = $record_field->getStatus()) {
            $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);
            $return = $icons->renderIconForStatus($status->status);
        }

        return $return;
    }

    public function initFilterFromTableView(): void
    {
        $this->filters = [];
        $this->filter = [];
        foreach ($this->tableview->getFilterableFieldSettings() as $field_set) {
            $field = $field_set->getFieldObject();
            ilDclCache::getFieldRepresentation($field)->addFilterInputFieldToTable($this);

            //set filter values
            $filter = end($this->filters);
            $value = $field_set->getFilterValue();
            $filter->setValueByArray($value);
            $filter->writeToSession();
            $this->applyFilter($field->getId(), empty(array_filter($value)) ? null : $filter->getValue());

            //Disable filters
            if (!$field_set->isFilterChangeable()) {
                $filter->setDisabled(true);
                if ($filter instanceof ilCombinationInputGUI) {
                    $filter->__call('setDisabled', [true]);
                }
            }
        }
    }

    public function initFilter(): void
    {
        foreach ($this->tableview->getFilterableFieldSettings() as $field_set) {
            $field = $field_set->getFieldObject();
            $value = ilDclCache::getFieldRepresentation($field)->addFilterInputFieldToTable($this);

            //Disable filters
            $filter = end($this->filters);
            if (!$field_set->isFilterChangeable()) {
                //always set tableview-filtervalue with disabled fields, so resetFilter won't reset it
                $value = $field_set->getFilterValue();
                $filter->setValueByArray($value);
                $value = $filter->getValue();

                $filter->setDisabled(true);
                if ($filter instanceof ilCombinationInputGUI) {
                    $filter->__call('setDisabled', [true]);
                }
            }

            $this->applyFilter($field->getId(), $value);
        }
    }

    public function applyFilter($field_id, $filter_value)
    {
        if ($filter_value) {
            $this->filter["filter_" . $field_id] = $filter_value;
        }
    }

    public function loadProperty(string $type): string
    {
        if ($this->getId() && $this->userId > 0) {
            $tab_prop = new ilTablePropertiesStorageGUI();
            return $tab_prop->getProperty($this->getId(), $this->userId, $type);
        }
        return "";
    }

    protected function getCommentJsLinkCode(int $recordId): string
    {
        $ajax_hash = ilCommonActionDispatcherGUI::buildAjaxHash(
            1,
            $this->parent_obj->getRefId(),
            'dcl',
            $this->parent_obj->getObjId(),
            'dcl',
            $recordId
        );

        return ilNoteGUI::getListCommentsJSCall($ajax_hash, '');
    }

    public function exportData(
        int $format,
        bool $send = false
    ): void {
        if ($this->dataExists()) {
            $exporter = new ilDclContentExporter(
                $this->parent_obj->getRefId(),
                $this->table->getId(),
                $this->filter
            );
            $exporter->export(ilDclContentExporter::EXPORT_EXCEL, null, true);
        }
    }
}