class.ilLSLaunchlinksBuilder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLSLaunchlinksBuilder
{
    public const PERM_PARTICIPATE = 'participate';
    public const PERM_UNPARTICIPATE = 'unparticipate';

    public const CMD_STANDARD = ilObjLearningSequenceLearnerGUI::CMD_STANDARD;
    public const CMD_EXTRO = ilObjLearningSequenceLearnerGUI::CMD_EXTRO;
    public const CMD_START = ilObjLearningSequenceLearnerGUI::CMD_START;
    public const CMD_VIEW = ilObjLearningSequenceLearnerGUI::CMD_VIEW;
    public const CMD_UNSUBSCRIBE = ilObjLearningSequenceLearnerGUI::CMD_UNSUBSCRIBE;

    protected ilLanguage $lng;
    protected ilAccess $access;
    protected ilCtrl $ctrl;
    protected ILIAS\UI\Factory $ui_factory;
    protected int $lso_ref_id;
    protected int $usr_id;
    protected $first_access;
    protected ilLearningSequenceRoles $roles;
    protected ilLSLearnerItemsQueries $ls_items;

    public function __construct(
        ilLanguage $language,
        ilAccess $access,
        ilCtrl $ctrl,
        ILIAS\UI\Factory $ui_factory,
        int $lso_ref_id,
        int $usr_id,
        $first_access,
        ilLearningSequenceRoles $roles,
        ilLSLearnerItemsQueries $ls_items
    ) {
        $this->lng = $language;
        $this->access = $access;
        $this->ctrl = $ctrl;
        $this->ui_factory = $ui_factory;

        $this->lso_ref_id = $lso_ref_id;
        $this->usr_id = $usr_id;
        $this->first_access = $first_access;
        $this->roles = $roles;
        $this->ls_items = $ls_items;
    }

    protected function mayJoin(): bool
    {
        return $this->access->checkAccess(self::PERM_PARTICIPATE, '', $this->lso_ref_id);
    }


    public function currentUserMayUnparticipate(): bool
    {
        return $this->mayUnparticipate();
    }

    protected function mayUnparticipate(): bool
    {
        return $this->access->checkAccess(self::PERM_UNPARTICIPATE, '', $this->lso_ref_id);
    }

    protected function isMember(): bool
    {
        return $this->roles->isMember($this->usr_id);
    }

    protected function hasCompleted(): bool
    {
        return $this->roles->isCompletedByUser($this->usr_id);
    }

    protected function getLink(string $cmd): string
    {
        return $this->ctrl->getLinkTargetByClass('ilObjLearningSequenceLearnerGUI', $cmd);
    }

    public function getLinks(): array
    {
        $cmd = $this->ctrl->getCmd();
        $links = [];

        if (!$this->isMember() && $this->mayJoin()) {
            if (!$this->ls_items->hasItems()) {
                return [];
            }
            return [[
                $this->lng->txt("lso_player_start"),
                $this->getLink(self::CMD_START),
                true
            ]];
        }

        if (!$this->hasCompleted() && $this->ls_items->hasItems()) {
            $label = "lso_player_resume";
            if ($this->first_access === -1) {
                $label = "lso_player_start";
            }
            $links[] = [
                $this->lng->txt($label),
                $this->getLink(self::CMD_VIEW),
                true
            ];
        } else {
            if ($this->ls_items->hasItems()) {
                $links[] = [
                    $this->lng->txt("lso_player_review"),
                    $this->getLink(self::CMD_VIEW),
                    true
                ];
            }

            if ($cmd === self::CMD_STANDARD) {
                $links[] = [
                    $this->lng->txt("lso_player_extro"),
                    $this->getLink(self::CMD_EXTRO),
                    false
                ];
            }
            if ($cmd === self::CMD_EXTRO) {
                $links[] = [
                    $this->lng->txt("lso_player_abstract"),
                    $this->getLink(self::CMD_STANDARD),
                    false
                ];
            }
        }

        if ($this->mayUnparticipate()) {
            $links[] = [
                $this->lng->txt("unparticipate"),
                $this->getLink(self::CMD_UNSUBSCRIBE),
                false
            ];
        }

        return $links;
    }

    public function getLaunchbuttonsComponent(): array
    {
        $buttons = [];
        foreach ($this->getLinks() as $idx => $entry) {
            list($label, $link) = $entry;
            $buttons[] = $this->ui_factory->button()->standard($label, $link);
        }
        return $buttons;
    }
}