This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilLSLaunchlinksBuilder:

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

	currentUserMayUnparticipate ()

	getLinks ()

	getLaunchbuttonsComponent ()

Data Fields
const	PERM_PARTICIPATE = 'participate'

const	PERM_UNPARTICIPATE = 'unparticipate'

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 = ilObjLearningSequenceLearnerGUI::CMD_UNSUBSCRIBE

Protected Member Functions
	mayJoin ()

	mayUnparticipate ()

	isMember ()

	hasCompleted ()

	getLink (string $cmd)

Protected Attributes
ilLanguage	$lng

ilAccess	$access

ilCtrl	$ctrl

ILIAS UI Factory	$ui_factory

int	$lso_ref_id

int	$usr_id

	$first_access

ilLearningSequenceRoles	$roles

ilLSLearnerItemsQueries	$ls_items

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 27 of file class.ilLSLaunchlinksBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

ilLSLaunchlinksBuilder::__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
	)

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

References $access, $ctrl, $first_access, $ls_items, $lso_ref_id, $roles, $ui_factory, $usr_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

       {
         $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;
     }

Here is the call graph for this function:

Member Function Documentation

◆ currentUserMayUnparticipate()

ilLSLaunchlinksBuilder::currentUserMayUnparticipate ( )

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

References mayUnparticipate().

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

Here is the call graph for this function:

◆ getLaunchbuttonsComponent()

ilLSLaunchlinksBuilder::getLaunchbuttonsComponent ( )

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

References getLinks().

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

Here is the call graph for this function:

◆ getLink()

ilLSLaunchlinksBuilder::getLink ( string $cmd )

protected

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

References ILIAS\Repository\ctrl().

Referenced by getLinks().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLinks()

ilLSLaunchlinksBuilder::getLinks ( )

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

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

Referenced by getLaunchbuttonsComponent().

                               : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasCompleted()

ilLSLaunchlinksBuilder::hasCompleted ( )

protected

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

Referenced by getLinks().

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

Here is the caller graph for this function:

◆ isMember()

ilLSLaunchlinksBuilder::isMember ( )

protected

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

Referenced by getLinks().

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

Here is the caller graph for this function:

◆ mayJoin()

ilLSLaunchlinksBuilder::mayJoin ( )

protected

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

References ILIAS\Repository\access().

Referenced by getLinks().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mayUnparticipate()

ilLSLaunchlinksBuilder::mayUnparticipate ( )

protected

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

References ILIAS\Repository\access().

Referenced by currentUserMayUnparticipate(), and getLinks().

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