class.ilBiblEntryTableGUI.php

Go to the documentation of this file.

<?php

use ILIAS\UI\Factory as UIFactory;
use ILIAS\HTTP\Services as HttpServices;
use ILIAS\UI\Renderer;
use ILIAS\Refinery\Factory;
use ILIAS\UI\Implementation\Component\Table\PresentationRow;
use ILIAS\UI\Component\Input\Container\Filter\Standard as StandardFilter;
use ILIAS\DI\UIServices;
use ILIAS\UI\Component\Table\Presentation as PresentationTable;

class ilBiblEntryTableGUI
{
    public const P_PAGE = 'page';
    public const P_SORTATION = 'sortation';
    public const SORTATION_BY_TITLE_ASC = 1;
    public const SORTATION_BY_TITLE_DESC = 2;
    public const SORTATION_BY_AUTHOR_ASC = 3;
    public const SORTATION_BY_AUTHOR_DESC = 4;
    public const SORTATION_BY_YEAR_ASC = 5;
    public const SORTATION_BY_YEAR_DESC = 6;

    private readonly HttpServices $http;
    private readonly ilLanguage $lng;
    private readonly UIFactory $ui_factory;
    private readonly Renderer $ui_renderer;
    private readonly ilCtrlInterface $ctrl;
    private readonly Factory $refinery;
    private int $current_page = 0;
    private int $entries_per_page = 10;
    private readonly ilUIService $ui_service;
    private ?StandardFilter $filter;
    private PresentationTable $table;

    protected array $filter_objects = [];

    public function __construct(
        protected ilObjBibliographicGUI $a_parent_obj,
        protected ilBiblFactoryFacade $facade,
        protected UIServices $ui
    ) {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->http = $DIC->http();
        $this->lng = $DIC->language();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->ui_service = $DIC->uiService();
        $this->refinery = $DIC->refinery();
        $this->ctrl->saveParameterByClass(ilObjBibliographicGUI::class, self::P_PAGE);
        $this->ctrl->saveParameterByClass(ilObjBibliographicGUI::class, self::P_SORTATION);

        $this->filter = $this->buildFilter();
        $this->table = $this->buildTable();
    }

    public function getRenderedTableAndExistingFilters(): string
    {
        if ($this->filter !== null) {
            $components[] = $this->filter;
        }
        $components[] = $this->table;
        return $this->ui_renderer->render($components);
    }

    protected function buildFilter(): ?StandardFilter
    {
        $filter_objects = $this->facade->filterFactory()->getAllForObjectId($this->facade->iliasObjId());
        if (empty($filter_objects)) {
            return null;
        }

        $available_field_ids_for_object = array_map(
            static fn(ilBiblField $field): ?int => $field->getId(),
            $this->facade->fieldFactory()->getAvailableFieldsForObjId($this->facade->iliasObjId())
        );

        $filter_inputs = [];
        $filter_active_states = [];
        foreach ($filter_objects as $filter_object) {
            if (in_array($filter_object->getFieldId(), $available_field_ids_for_object, true)) {
                $filter_presentation = new ilBiblFieldFilterPresentationGUI($filter_object, $this->facade);
                $field = $this->facade->fieldFactory()->findById($filter_object->getFieldId());
                $post_var = $field->getIdentifier();
                $filter_input = $filter_presentation->getFilterInput();
                $filter_inputs[$post_var] = $filter_input;
                $filter_active_states[] = true;
                $this->filter_objects[$post_var] = $filter_object;
            }
        }

        return $this->ui_service->filter()->standard(
            'bibl_entry_filter',
            $this->ctrl->getLinkTargetByClass(
                ilObjBibliographicGUI::class,
                ilObjBibliographicGUI::CMD_SHOW_CONTENT,
                "",
                true
            ),
            $filter_inputs,
            $filter_active_states,
            true,
            true
        );
    }

    private function renderLibraryButtons(int $entry_id): array
    {
        $entry = $this->facade->entryFactory()->findByIdAndTypeString(
            $entry_id,
            $this->facade->type()->getStringRepresentation()
        );

        $settings = $this->facade->libraryFactory()->getAll();
        if ($settings === []) {
            return [];
        }

        $buttons = [];

        foreach ($settings as $set) {
            $presentation = new ilBiblLibraryPresentationGUI($set, $this->facade, $this->ctrl, $this->lng, $this->ui);
            $buttons[$set->getName()] = $presentation->getButton($this->facade, $entry);
        }

        return $buttons;
    }

    protected function buildTable(): PresentationTable
    {
        $records = $this->getData();
        $sorted_records = $this->getSortedRecords($records);
        $this->current_page = $this->determinePage();
        $records_current_page = $this->getRecordsOfCurrentPage($sorted_records);
        $view_controls = [];
        $sortations = [];
        foreach (array_keys($this->getSortationsMapping()) as $sort_id) {
            $sortations[$sort_id] = $this->lng->txt('sorting_' . $sort_id);
        }
        if ($sortations !== []) {
            $view_controls[] = $this->ui_factory->viewControl()->sortation($sortations, array_key_first($sortations))
                                                ->withTargetURL(
                                                    $this->ctrl->getLinkTargetByClass(
                                                        ilObjBibliographicGUI::class,
                                                        ilObjBibliographicGUI::CMD_SHOW_CONTENT
                                                    ),
                                                    self::P_SORTATION
                                                );
        }

        $view_controls[] = $this->ui_factory->viewControl()->pagination()
                                            ->withTargetURL($this->http->request()->getRequestTarget(), self::P_PAGE)
                                            ->withTotalEntries(count($records))
                                            ->withPageSize($this->entries_per_page)
                                            ->withCurrentPage($this->current_page);

        return $this->ui_factory->table()->presentation(
            "",
            $view_controls,
            function (
                PresentationRow $row,
                array $record,
                UIFactory $ui_factory
            ): PresentationRow {
                // Create row with fields and actions
                $record['author'] = empty($record['author']) ? null : $record['author'];
                $record['title'] = empty($record['title']) ? null : $record['title'];
                $record['year'] = empty($record['year']) ? null : $record['year'];

                $author = $record['autor'] = $record['author'] ?? $record['AU'] ?? '';
                $title = ($record['title'] ??= $record['TI'] ?? '');
                $year = ($record['year'] ??= $record['PY'] ?? '');
                $entry_id = $record['entry_id'];

                unset($record['author'], $record['title'], $record['AU'], $record['TI'], $record['entry_id']);

                $translated_record = $this->getRecordWithTranslatedKeys($record);

                $this->ctrl->setParameterByClass(ilObjBibliographicGUI::class, 'entry_id', $entry_id);

                return $row
                    ->withHeadline($title)
                    ->withAction(
                        $this->ui_factory->button()->shy(
                            $this->lng->txt('detail_view'),
                            $this->ctrl->getLinkTargetByClass(
                                ilObjBibliographicGUI::class,
                                'showDetails'
                            )
                        )
                    )
                    ->withSubheadline($author)
                    ->withImportantFields([$year])
                    ->withFurtherFields($this->renderLibraryButtons($entry_id))
                    ->withContent($ui_factory->listing()->descriptive($translated_record));
            }
        )->withData($records_current_page);
    }

    protected function getData(): array
    {
        $query = new ilBiblTableQueryInfo();

        $filter_data = ($this->filter !== null) ? ($this->ui_service->filter()->getData($this->filter) ?? []) : [];
        foreach ($filter_data as $field_name => $field_value) {
            if (empty($field_value)) {
                continue;
            }
            if (is_array($field_value) && $field_value === []) {
                continue;
            }
            $filter = $this->filter_objects[$field_name];
            $filter_info = new ilBiblTableQueryFilter();
            $filter_info->setFieldName($field_name);
            switch ($filter->getFilterType()) {
                case ilBiblFieldFilterInterface::FILTER_TYPE_MULTI_SELECT_INPUT:
                    $filter_info->setFieldValue($field_value);
                    $filter_info->setOperator("IN");
                    break;
                case ilBiblFieldFilterInterface::FILTER_TYPE_SELECT_INPUT:
                    $filter_info->setFieldValue($field_value);
                    $filter_info->setOperator("=");
                    break;
                case ilBiblFieldFilterInterface::FILTER_TYPE_TEXT_INPUT:
                    $filter_info->setFieldValue("%$field_value%");
                    $filter_info->setOperator("LIKE");
                    break;
            }

            $query->addFilter($filter_info);
        }

        $bibl_data = [];
        $object_id = $this->facade->iliasObjId();
        $entries = $this->facade->entryFactory()->filterEntryIdsForTableAsArray($object_id, $query);

        foreach ($entries as $entry) {
            $bibl_entry = $this->facade->entryFactory()->findByIdAndTypeString(
                $entry['entry_id'],
                $entry['entry_type']
            );
            $entry_attributes = $this->facade->attributeFactory()->getAttributesForEntry($bibl_entry);
            $sorted_attributes = $this->facade->attributeFactory()->sortAttributes($entry_attributes);
            $entry_data = [];
            $entry_data['entry_id'] = $entry['entry_id'];
            foreach ($sorted_attributes as $sorted_attribute) {
                $entry_data[$sorted_attribute->getName()] = $sorted_attribute->getValue();
            }
            $entry_data['author'] ??= $entry_data['AU'] ?? $entry_data['A1'] ?? $entry_data['A2'] ?? '';
            $entry_data['title'] ??= $entry_data['T1'] ?? $entry_data['T2'] ?? '';
            $entry_data['year'] ??= $entry_data['PY'] ?? $entry_data['Y1'] ?? '';
            $bibl_data[] = $entry_data;
        }

        return $bibl_data;
    }

    protected function getSortedRecords(array $records): array
    {
        $sortation = $this->determineSortation();
        $sortation_mapping = $this->getSortationsMapping();
        $sortation_string = $sortation_mapping[$sortation];
        $sortation_parts = explode(' ', (string) $sortation_string);
        $sortation_field = array_column($records, $sortation_parts[0]);
        $sortation_direction = ($sortation_parts[1] === 'ASC') ? SORT_ASC : SORT_DESC;
        array_multisort($sortation_field, $sortation_direction, $records);
        return $records;
    }

    protected function getRecordsOfCurrentPage(array $records): array
    {
        $offset = array_search($this->current_page * $this->entries_per_page, array_keys($records), true);
        $length = $this->entries_per_page;
        return array_slice($records, $offset, $length);
    }

    protected function getRecordWithTranslatedKeys(array $record): array
    {
        $record = $this->facade->attributeFactory()->sortAttributesArray($record);

        $translated_record = [];
        foreach ($record as $key => $value) {
            $field = ilBiblField::where(['identifier' => $key])->first();
            $translated_key = $key;
            if ($field !== null) {
                $translated_key = $this->facade->translationFactory()->translate($field);
            }
            $translated_record[$translated_key] = $value;
        }
        return $translated_record;
    }

    private function determinePage(): int
    {
        return $this->http->wrapper()->query()->has(self::P_PAGE)
            ? $this->http->wrapper()->query()->retrieve(self::P_PAGE, $this->refinery->kindlyTo()->int())
            : 0;
    }

    private function determineSortation(): int
    {
        return $this->http->wrapper()->query()->has(self::P_SORTATION)
            ? $this->http->wrapper()->query()->retrieve(self::P_SORTATION, $this->refinery->kindlyTo()->int())
            : array_keys($this->getSortationsMapping())[0] ?? self::SORTATION_BY_TITLE_ASC;
    }

    public function getSortationsMapping(): array
    {
        return [
            self::SORTATION_BY_TITLE_ASC => 'title ASC',
            self::SORTATION_BY_TITLE_DESC => 'title DESC',
            self::SORTATION_BY_AUTHOR_ASC => 'author ASC',
            self::SORTATION_BY_AUTHOR_DESC => 'author DESC',
            self::SORTATION_BY_YEAR_ASC => 'year ASC',
            self::SORTATION_BY_YEAR_DESC => 'year DESC'
        ];
    }
}