Builds the links to join/(re-)start the LearningSequence. More...

Collaboration diagram for ilLSLaunchlinksBuilder:

Public Member Functions
	__construct (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)

	currentUserMayUnparticipate ()

	getLinks ()

	getLaunchbuttonsComponent ()

Data Fields
const	CMD_STANDARD = ilObjLearningSequenceLearnerGUI::CMD_STANDARD

const	CMD_EXTRO = ilObjLearningSequenceLearnerGUI::CMD_EXTRO

const	CMD_START = ilObjLearningSequenceLearnerGUI::CMD_START

const	CMD_VIEW = ilObjLearningSequenceLearnerGUI::CMD_VIEW

const	CMD_UNSUBSCRIBE_CONFIRMATION = ilObjLearningSequenceLearnerGUI::CMD_UNSUBSCRIBE_CONFIRMATION

Protected Member Functions
	mayJoin ()

	mayUnparticipate ()

	isMember ()

	hasCompleted ()

	getLink (string $cmd)

Detailed Description

Builds the links to join/(re-)start the LearningSequence.

Author: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 26 of file class.ilLSLaunchlinksBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

ilLSLaunchlinksBuilder::__construct	(	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
	)

Definition at line 34 of file class.ilLSLaunchlinksBuilder.php.

44 {

45 }

Member Function Documentation

◆ currentUserMayUnparticipate()

ilLSLaunchlinksBuilder::currentUserMayUnparticipate ( )

Definition at line 52 of file class.ilLSLaunchlinksBuilder.php.

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

References mayUnparticipate().

Here is the call graph for this function:

◆ getLaunchbuttonsComponent()

ilLSLaunchlinksBuilder::getLaunchbuttonsComponent ( )

Definition at line 139 of file class.ilLSLaunchlinksBuilder.php.

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

References getLinks().

Here is the call graph for this function:

◆ getLink()

ilLSLaunchlinksBuilder::getLink ( string $cmd )

protected

Definition at line 72 of file class.ilLSLaunchlinksBuilder.php.

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

References ILIAS\Repository\ctrl().

Referenced by getLinks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLinks()

ilLSLaunchlinksBuilder::getLinks ( )

Definition at line 77 of file class.ilLSLaunchlinksBuilder.php.

                              : 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_CONFIRMATION),
                false
            ];
        }
 
        return $links;
    }

References ILIAS\Repository\ctrl(), getLink(), hasCompleted(), isMember(), ILIAS\Repository\lng(), mayJoin(), and mayUnparticipate().

Referenced by getLaunchbuttonsComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasCompleted()

ilLSLaunchlinksBuilder::hasCompleted ( )

protected

Definition at line 67 of file class.ilLSLaunchlinksBuilder.php.

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

Referenced by getLinks().

Here is the caller graph for this function:

◆ isMember()

ilLSLaunchlinksBuilder::isMember ( )

protected

Definition at line 62 of file class.ilLSLaunchlinksBuilder.php.

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

Referenced by getLinks(), and mayUnparticipate().

Here is the caller graph for this function:

◆ mayJoin()

ilLSLaunchlinksBuilder::mayJoin ( )

protected

Definition at line 47 of file class.ilLSLaunchlinksBuilder.php.

                                : bool
    {
        return $this->access->checkAccess('read', '', $this->lso_ref_id);
    }

References ILIAS\Repository\access().

Referenced by getLinks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mayUnparticipate()

ilLSLaunchlinksBuilder::mayUnparticipate ( )

protected

Definition at line 57 of file class.ilLSLaunchlinksBuilder.php.

                                         : bool
    {
        return $this->isMember() && $this->access->checkAccess('read', '', $this->lso_ref_id);
    }