class.ilUserRoleStartingPointTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer;

class ilUserRoleStartingPointTableGUI extends ilTable2GUI
{
    private const TABLE_POSITION_USER_CHOOSES = -1;
    private const TABLE_POSITION_DEFAULT = 9999;

    public function __construct(
        object $parent_obj,
        private ilUserStartingPointRepository $starting_point_repository,
        private ilRbacReview $rbac_review,
        private UIFactory $ui_factory,
        private Renderer $ui_renderer,
    ) {
        $this->setId('usrrolesp');

        parent::__construct($parent_obj);

        $this->getItems();

        $this->setLimit(9999);
        $this->setTitle($this->lng->txt('user_role_starting_point'));

        $this->addColumn($this->lng->txt('user_order'));
        $this->addColumn($this->lng->txt('criteria'));
        $this->addColumn($this->lng->txt('starting_page'));
        $this->addColumn($this->lng->txt('actions'));
        $this->setFormAction($this->ctrl->getFormAction($parent_obj));
        $this->setRowTemplate('tpl.user_role_starting_point_row.html', 'components/ILIAS/User');
        $this->addCommandButton('saveOrder', $this->lng->txt('save_order'));

        $this->setExternalSorting(true);
    }

    public function getItems(): void
    {
        $dc = new ilObjectDataCache();

        $valid_points = $this->starting_point_repository->getPossibleStartingPoints();

        $status = ($this->starting_point_repository->isPersonalStartingPointEnabled()
            ? $this->lng->txt('yes') : $this->lng->txt('no'));

        $starting_points = [];
        $starting_points[] = [
            'id' => $this->starting_point_repository->getUserStartingPointID(),
            'criteria' => $this->lng->txt('user_chooses_starting_page'),
            'starting_page' => $status,
            'starting_position' => self::TABLE_POSITION_USER_CHOOSES
        ];

        $available_starting_points = $this->starting_point_repository->getStartingPoints();

        foreach ($available_starting_points as $available_starting_point) {
            $starting_point_type = $available_starting_point->getStartingPointType();
            $position = $available_starting_point->getPosition();
            $sp_text = $this->lng->txt($valid_points[$starting_point_type]) ?? '';

            if ($starting_point_type === ilUserStartingPointRepository::START_REPOSITORY_OBJ
                && $available_starting_point->getStartingObject() !== null) {
                $starting_object_ref_id = $available_starting_point->getStartingObject();
                $object_id = ilObject::_lookupObjId($starting_object_ref_id);
                $type = $dc->lookupType($object_id);
                $title = $dc->lookupTitle($object_id);
                $sp_text = $this->lng->txt('obj_' . $type) . ' '
                    . '<i>"' . $title . '" (' . $starting_object_ref_id . ')</i>';
            }

            if ($available_starting_point->isRoleBasedStartingPoint()) {
                $options = unserialize($available_starting_point->getRuleOptions(), ['allowed_classes' => false]);

                $role_obj = ilObjectFactory::getInstanceByObjId((int) $options['role_id'], false);
                if (!($role_obj instanceof \ilObjRole)) {
                    continue;
                }

                $starting_points[] = [
                    'id' => $available_starting_point->getId(),
                    'criteria' => $role_obj->getTitle(),
                    'starting_page' => $sp_text,
                    'starting_position' => $position,
                    'role_id' => $role_obj->getId()
                ];
            }
        }

        $default_sp = $this->starting_point_repository->getSystemDefaultStartingPointType();
        $starting_point = $this->lng->txt($valid_points[$default_sp]);
        if ($default_sp === ilUserStartingPointRepository::START_REPOSITORY_OBJ) {
            $starting_object_ref_id = $this->starting_point_repository->getSystemDefaultStartingObject();

            $object_id = ilObject::_lookupObjId($starting_object_ref_id);
            $type = $dc->lookupType($object_id);
            $title = $dc->lookupTitle($object_id);
            $starting_point = $this->lng->txt('obj_' . $type) . ' '
                . '<i>"' . $title . '" (' . $starting_object_ref_id . ')</i>';
        }

        $starting_points[] = [
            'id' => $this->starting_point_repository->getDefaultStartingPointID(),
            'criteria' => $this->lng->txt('default'),
            'starting_page' => $starting_point,
            'starting_position' => self::TABLE_POSITION_DEFAULT
        ];

        $sorted_starting_points = $this->starting_point_repository->reArrangePositions(
            ilArrayUtil::sortArray($starting_points, 'starting_position', 'asc', true)
        );

        $this->setData($sorted_starting_points);
    }

    protected function fillRow(array $row_data): void
    {
        $id = $row_data['id'];
        $role_id = $row_data['role_id'] ?? null;
        $this->ctrl->setParameter($this->getParentObject(), 'spid', $id);

        if ($this->isSortingHidden($id)) {
            $this->tpl->setVariable('HIDDEN', 'hidden');
        } else {
            $this->tpl->setVariable('VAL_ID', 'position[' . (string) $id . ']');
            $this->tpl->setVariable('VAL_POS', $row_data['starting_position']);
        }

        $this->tpl->setVariable(
            'TXT_TITLE',
            $this->getTitleForCriterium(
                $id,
                $role_id,
                $row_data['criteria']
            )
        );

        $actions = $this->getActions($id, $role_id);

        $this->tpl->setVariable('TXT_PAGE', $row_data['starting_page']);

        $list = $this->ui_factory->dropdown()->standard($actions)->withLabel(
            $this->lng->txt('actions')
        );

        $this->tpl->setVariable('ACTION', $this->ui_renderer->render($list));
    }

    private function getActions(int $id, ?int $role_id): array
    {
        $actions = [];

        $edit_url = $this->getEditLink($id, $role_id);

        $actions[] = $this->ui_factory->link()->standard(
            $this->lng->txt('edit'),
            $edit_url
        );

        if ($id !== $this->starting_point_repository->getDefaultStartingPointID()
            && $id !== $this->starting_point_repository->getUserStartingPointID()) {
            $delete_url = $this->ctrl->getLinkTarget(
                $this->getParentObject(),
                'deleteStartingPoint'
            );
            $actions[] = $this->ui_factory->link()->standard(
                $this->lng->txt('delete'),
                $delete_url
            );
        }

        return $actions;
    }

    private function getEditLink(int $id, ?int $role_id): string
    {
        $cmd = 'initRoleStartingPointForm';
        if ($id === $this->starting_point_repository->getUserStartingPointID()) {
            $cmd = 'initUserStartingPointForm';
        }

        $this->ctrl->setParameter($this->getParentObject(), 'rolid', $role_id);
        return $this->ctrl->getLinkTargetByClass(
            get_class($this->getParentObject()),
            $cmd
        );
    }

    private function isSortingHidden(int $id): bool
    {
        if ($id === $this->starting_point_repository->getDefaultStartingPointID()
            || $id === $this->starting_point_repository->getUserStartingPointID()) {
            return true;
        }
        return false;
    }

    private function getTitleForCriterium(
        int $id,
        ?int $role_id,
        string $criterium
    ): string {
        if ($id === $this->starting_point_repository->getDefaultStartingPointID()
            || $id === $this->starting_point_repository->getUserStartingPointID()) {
            return $criterium;
        }

        $parent_title = '';
        if ($role_id !== null && ilObject::_lookupType($role_id) === 'role') {
            $ref_id = $this->rbac_review->getObjectReferenceOfRole($role_id);
            if ($ref_id !== ROLE_FOLDER_ID) {
                $parent_title = ' (' . ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)) . ')';
            }
        }
        return $this->lng->txt('has_role') . ': '
            . ilObjRole::_getTranslation($criterium)
            . $parent_title;
    }
}