class.ilObjDashboardSettingsGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\DI\UIServices;
use ILIAS\Style\Content\GUIService;
use ILIAS\UI\Factory;
use ILIAS\UI\Implementation\Component\Input\Field\FormInput;
use ILIAS\UI\Renderer;
use ILIAS\UI\Component\Input\Container\Form\Standard as StandardForm;
use ILIAS\UI\Component\Input\Field\Section;

class ilObjDashboardSettingsGUI extends ilObjectGUI
{
    public const VIEW_MODE_SETTINGS = 'Settings';
    public const VIEW_MODE_PRESENTATION = 'Presentation';
    public const VIEW_MODE_SORTING = 'Sorting';
    public const DASH_SORT_PREFIX = 'dash_sort_by_';
    public const DASH_ENABLE_PREFIX = 'dash_enable_';

    protected Factory $ui_factory;
    protected Renderer $ui_renderer;
    protected ilPDSelectedItemsBlockViewSettings $viewSettings;
    protected UIServices $ui;
    protected ilDashboardSidePanelSettingsRepository $side_panel_settings;
    protected GUIService $style_gui;

    public function __construct(
        $a_data,
        int $a_id,
        bool $a_call_by_reference = true,
        bool $a_prepare_output = true
    ) {
        global $DIC;

        $this->lng = $DIC->language();
        $this->rbac_system = $DIC->rbac()->system();
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->settings = $DIC->settings();
        $lng = $DIC->language();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->request = $DIC->http()->request();
        $this->ui = $DIC->ui();
        $this->style_gui = $DIC->contentStyle()->gui();

        $this->type = 'dshs';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

        $lng->loadLanguageModule('dash');

        $this->viewSettings = new ilPDSelectedItemsBlockViewSettings($DIC->user());

        $this->side_panel_settings = new ilDashboardSidePanelSettingsRepository();
    }

    public function executeCommand(): void
    {
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        if (!$this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            throw new ilPermissionException($this->lng->txt('no_permission'));
        }

        switch ($this->ctrl->getNextClass($this)) {
            case strtolower(ilPermissionGUI::class):
                $this->tabs_gui->activateTab('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            case strtolower(ilDashboardPageLanguageSelectGUI::class):
                $this->tabs_gui->activateTab('dash_customization');
                $this->ctrl->forwardCommand(new ilDashboardPageLanguageSelectGUI());
                break;
            case strtolower(ilObjectContentStyleSettingsGUI::class):
                $this->tabs_gui->clearTargets();
                $this->ctrl->setParameterByClass(ilDashboardPageGUI::class, 'dshs_lang', $this->request->getQueryParams()['dshs_lang']);
                $this->tabs_gui->setBackTarget($this->lng->txt('back'), $this->ctrl->getLinkTargetByClass(
                    [ilDashboardPageLanguageSelectGUI::class, ilDashboardPageGUI::class],
                    'edit'
                ));
                $gui = $this->style_gui->objectSettingsGUIForRefId(null, $this->getRefId());
                $this->ctrl->setParameter($gui, 'dshs_lang', $this->request->getQueryParams()['dshs_lang']);
                $this->ctrl->forwardCommand($gui);
                break;
            default:
                $this->tabs_gui->activateTab('settings');
                if (!$cmd || $cmd === 'view') {
                    $cmd = 'editSettings';
                }

                $this->$cmd();
                break;
        }
    }

    public function getAdminTabs(): void
    {
        if ($this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'settings',
                $this->ctrl->getLinkTarget($this, 'editSettings'),
                ['editSettings', 'view']
            );
            $this->tabs_gui->addTarget(
                'dash_customization',
                $this->ctrl->getLinkTargetByClass(ilDashboardPageLanguageSelectGUI::class)
            );
        }

        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'perm_settings',
                $this->ctrl->getLinkTargetByClass(ilPermissionGUI::class, 'perm'),
                [],
                ilPermissionGUI::class
            );
        }
    }

    public function editSettings(): void
    {
        if ($this->settings->get('rep_favourites', '0') !== '1') {
            $content[] = $this->ui_factory->messageBox()->info($this->lng->txt('favourites_disabled_info'));
        }

        if ($this->settings->get('mmbr_my_crs_grp', '0') !== '1') {
            $content[] = $this->ui_factory->messageBox()->info($this->lng->txt('memberships_disabled_info'));
        }
        $this->setSettingsSubTabs('general');
        $table = new ilDashboardSortationTableGUI($this, 'editSettings', !$this->canWrite());
        $this->tpl->setContent($table->getHTML());
    }

    public function editSorting(): void
    {
        $this->tabs_gui->activateTab('settings');
        $this->setSettingsSubTabs('sorting');
        $form = $this->getViewForm(self::VIEW_MODE_SORTING);
        $this->tpl->setContent($this->ui->renderer()->renderAsync($form));
    }

    public function getViewForm(string $mode): ?StandardForm
    {
        switch ($mode) {
            case self::VIEW_MODE_PRESENTATION:
            case self::VIEW_MODE_SORTING:
                return $this->ui_factory->input()->container()->form()->standard(
                    $this->ctrl->getFormAction($this, 'save' . $mode),
                    array_map(
                        fn(int $view): Section => $this->getViewByMode($mode, $view),
                        $this->viewSettings->getPresentationViews()
                    )
                );
        }
        return null;
    }

    public function getViewSectionSorting(int $view, string $title): Section
    {
        if ($this->canWrite()) {
            $this->tpl->addJavaScript("assets/js/SortationUserInputHandler.js");
        }
        $lng = $this->lng;
        $availabe_sort_options = $this->viewSettings->getAvailableSortOptionsByView($view);
        $options = array_reduce(
            $availabe_sort_options,
            static function (array $options, string $option) use ($lng): array {
                $options[$option] = $lng->txt(self::DASH_SORT_PREFIX . $option);
                return $options;
            },
            []
        );

        $available_sorting = $this->ui_factory
            ->input()
            ->field()
            ->multiSelect($this->lng->txt('dash_avail_sortation'), $options)
            ->withValue(
                $this->viewSettings->getActiveSortingsByView($view)
            )
            ->withAdditionalOnLoadCode(
                static fn(string $id) => "document.getElementById('$id').setAttribute('data-checkbox', 'activeSorting$view');
                    document.addEventListener('DOMContentLoaded', function () {
                        il.Dashboard.handleUserInputForSortationsByView($view);
                    });"
            );
        $default_sorting = $this->ui_factory
            ->input()
            ->field()
            ->select($this->lng->txt('dash_default_sortation'), $options)
            ->withValue($this->viewSettings->getDefaultSortingByView($view))
            ->withRequired(true)
            ->withAdditionalOnLoadCode(
                static fn(string $id) => "document.getElementById('$id').setAttribute('data-select', 'sorting$view');"
            );
        return $this->ui_factory->input()->field()->section(
            $this->maybeDisable(['avail_sorting' => $available_sorting, 'default_sorting' => $default_sorting]),
            $title
        );
    }

    public function getViewByMode(string $mode, int $view): Section
    {
        switch ($mode) {
            case self::VIEW_MODE_SORTING:
                return $this->getViewSectionSorting(
                    $view,
                    $this->lng->txt('dash_' . $this->viewSettings->getViewName($view))
                );
            case self::VIEW_MODE_PRESENTATION:
            default:
                return $this->getViewSectionPresentation(
                    $view,
                    $this->lng->txt('dash_' . $this->viewSettings->getViewName($view))
                );
        }
    }

    public function saveSettings(): void
    {
        if ($this->canWrite()) {
            $form_data = $this->request->getParsedBody();
            foreach ($this->viewSettings->getPresentationViews() as $presentation_view) {
                if (isset($form_data['main_panel']['enable'][$presentation_view])) {
                    $this->viewSettings->enableView(
                        $presentation_view,
                        (bool) $form_data['main_panel']['enable'][$presentation_view]
                    );
                } elseif ($presentation_view !== ilPDSelectedItemsBlockConstants::VIEW_RECOMMENDED_CONTENT) {
                    $this->viewSettings->enableView($presentation_view, false);
                }
            }

            $positions = $form_data['main_panel']['position'];
            asort($positions);
            $this->viewSettings->setViewPositions(array_keys($positions));

            foreach ($this->side_panel_settings->getValidModules() as $mod) {
                $this->side_panel_settings->enable($mod, (bool) ($form_data['side_panel']['enable'][$mod] ?? false));
            }

            $positions = $form_data['side_panel']['position'];
            asort($positions);
            $this->side_panel_settings->setPositions(array_keys($positions));

            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
        } else {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_FAILURE, $this->lng->txt('no_permission'), true);
        }
        $this->editSettings();
    }

    public function setSettingsSubTabs(string $a_active): void
    {
        $tabs = $this->tabs_gui;
        $ctrl = $this->ctrl;
        $lng = $this->lng;

        if ($this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $tabs->addSubTab(
                'general',
                $lng->txt('general_settings'),
                $ctrl->getLinkTarget($this, 'editSettings')
            );

            $tabs->addSubTab(
                'presentation',
                $lng->txt('dash_presentation'),
                $ctrl->getLinkTarget($this, 'editPresentation')
            );

            $tabs->addSubTab(
                'sorting',
                $lng->txt('dash_sortation'),
                $ctrl->getLinkTarget($this, 'editSorting')
            );
        }

        $tabs->activateSubTab($a_active);
    }

    public function editPresentation(): void
    {
        $this->tabs_gui->activateTab('settings');
        $this->setSettingsSubTabs('presentation');

        $form = $this->getViewForm(self::VIEW_MODE_PRESENTATION);

        $this->tpl->setContent($this->ui->renderer()->renderAsync($form));
    }

    public function editCustomization(): void
    {
        $this->ui->mainTemplate()->setOnScreenMessage(
            $this->ui->mainTemplate()::MESSAGE_TYPE_INFO,
            $this->lng->txt('dash_page_edit_info'),
            true
        );

        $this->tabs_gui->activateTab('dash_customization');

        $content = $this->ui->renderer()->render(
            $this->ui->factory()->button()->standard(
                $this->lng->txt('customize_page'),
                $this->ctrl->getLinkTargetByClass([self::class, ilDashboardPageLanguageSelectGUI::class], 'select')
            )
        );

        if (ilDashboardPageGUI::isLanguageAvailable($this->user->getLanguage())) {
            $content .= (new ilDashboardPageGUI($this->user->getLanguage()))->showPage();
        } elseif (ilDashboardPageGUI::isLanguageAvailable($this->lng->getContentLanguage())) {
            $content .= (new ilDashboardPageGUI($this->lng->getDefaultLanguage()))->showPage();
        }

        $this->tpl->setContent($content);
    }

    public function getViewSectionPresentation(int $view, string $title): Section
    {
        $lng = $this->lng;
        $ops = $this->viewSettings->getAvailablePresentationsByView($view);
        $pres_options = array_column(
            array_map(
                static fn(int $k, string $v): array => [$v, $lng->txt('dash_' . $v)],
                array_keys($ops),
                $ops
            ),
            1,
            0
        );
        $avail_pres = $this->ui_factory->input()->field()->multiSelect(
            $lng->txt('dash_avail_presentation'),
            $pres_options
        )
                                       ->withValue($this->viewSettings->getActivePresentationsByView($view));
        $default_pres = $this->ui_factory->input()->field()->radio($lng->txt('dash_default_presentation'))
                                         ->withOption('list', $lng->txt('dash_list'))
                                         ->withOption('tile', $lng->txt('dash_tile'));
        $default_pres = $default_pres->withValue($this->viewSettings->getDefaultPresentationByView($view));
        return $this->ui_factory->input()->field()->section(
            $this->maybeDisable(['avail_pres' => $avail_pres, 'default_pres' => $default_pres]),
            $title
        );
    }

    protected function savePresentation(): void
    {
        if ($this->canWrite()) {
            $data = $this->getViewForm(self::VIEW_MODE_PRESENTATION)->withRequest($this->request)->getData();

            foreach ($data as $view => $view_data) {
                $this->viewSettings->storeViewPresentation(
                    $view,
                    $view_data['default_pres'],
                    $view_data['avail_pres'] ?? []
                );
            }
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('msg_obj_modified'), true);
        } else {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_FAILURE, $this->lng->txt('no_permission'), true);
        }
        $this->editPresentation();
    }

    public function saveSorting(): void
    {
        if ($this->canWrite()) {
            $data = $this->getViewForm(self::VIEW_MODE_SORTING)->withRequest($this->request)->getData();

            foreach ($data as $view => $view_data) {
                if (isset($view_data['default_sorting'])) {
                    if (!is_array($view_data['avail_sorting'] ?? null)) {
                        $view_data['avail_sorting'] = [$view_data['default_sorting']];
                    }
                    $this->viewSettings->storeViewSorting(
                        $view,
                        $view_data['default_sorting'],
                        $view_data['avail_sorting']
                    );
                }
            }
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('msg_obj_modified'), true);
        } else {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_FAILURE, $this->lng->txt('no_permission'), true);
        }
        $this->editSorting();
    }

    private function maybeDisable(array $fields): array
    {
        if ($this->canWrite()) {
            return $fields;
        }

        return array_map(static fn(FormInput $field): FormInput => $field->withDisabled(true), $fields);
    }

    private function canWrite(): bool
    {
        return $this->rbac_system->checkAccess('write', $this->object->getRefId());
    }
}