Class ilObjLearningSequenceLearnerGUI. More...

Collaboration diagram for ilObjLearningSequenceLearnerGUI:

Public Member Functions
	__construct (int $ls_ref_id, $first_access, int $usr_id, ilAccess $access, ilCtrl $ctrl, ilLanguage $lng, ilGlobalTemplateInterface $tpl, ilToolbarGUI $toolbar, ILIAS\UI\Factory $ui_factory, ILIAS\UI\Renderer $ui_renderer, ilLearningSequenceRoles $roles, ilLearningSequenceSettings $settings, ilLSCurriculumBuilder $curriculum_builder, ilLSPlayer $player)

	executeCommand ()

Data Fields
const	CMD_STANDARD = 'learnerView'

const	CMD_EXTRO = 'learnerViewFinished'

const	CMD_UNSUBSCRIBE = 'unsubscribe'

const	CMD_VIEW = 'view'

const	CMD_START = 'start'

const	PARAM_LSO_NEXT_ITEM = 'lsoni'

const	LSO_CMD_NEXT = 'lson'

const	LSO_CMD_PREV = 'lsop'

Protected Member Functions
	view (string $cmd)

	addMember (int $usr_id)

	userMayUnparticipate ()

	userMayJoin ()

	initToolbar (string $cmd)

	play ()

	getCurrentItemLearningProgress ()

Private Member Functions
	getWrappedHTML (array $components)

	getMainContent (string $cmd)

Detailed Description

Class ilObjLearningSequenceLearnerGUI.

Definition at line 6 of file class.ilObjLearningSequenceLearnerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjLearningSequenceLearnerGUI::__construct	(	int	$ls_ref_id,
			$first_access,
		int	$usr_id,
		ilAccess	$access,
		ilCtrl	$ctrl,
		ilLanguage	$lng,
		ilGlobalTemplateInterface	$tpl,
		ilToolbarGUI	$toolbar,
		ILIAS\UI\Factory	$ui_factory,
		ILIAS\UI\Renderer	$ui_renderer,
		ilLearningSequenceRoles	$roles,
		ilLearningSequenceSettings	$settings,
		ilLSCurriculumBuilder	$curriculum_builder,
		ilLSPlayer	$player
	)

Definition at line 17 of file class.ilObjLearningSequenceLearnerGUI.php.

References $lng, $tpl, and settings().

       {
         $this->ls_object = $ls_object;
         $this->ls_ref_id = $ls_ref_id;
         $this->first_access = $first_access;
         $this->usr_id = $usr_id;
         $this->access = $access;
         $this->ctrl = $ctrl;
         $this->lng = $lng;
         $this->tpl = $tpl;
         $this->toolbar = $toolbar;
         $this->ui_factory = $ui_factory;
         $this->renderer = $ui_renderer;
         $this->roles = $roles;
         $this->settings = $settings;
         $this->curriculum_builder = $curriculum_builder;
         $this->player = $player;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addMember()

ilObjLearningSequenceLearnerGUI::addMember ( int $usr_id )

protected

Definition at line 101 of file class.ilObjLearningSequenceLearnerGUI.php.

Referenced by executeCommand().

     {
         $admins = $this->roles->getLearningSequenceAdminIds();
         if (!in_array($usr_id, $admins)) {
             $this->roles->join($usr_id);
         }
     }

Here is the caller graph for this function:

◆ executeCommand()

ilObjLearningSequenceLearnerGUI::executeCommand ( )

Definition at line 50 of file class.ilObjLearningSequenceLearnerGUI.php.

References addMember(), LSControlBuilder\CMD_CHECK_CURRENT_ITEM_LP, getCurrentItemLearningProgress(), play(), userMayUnparticipate(), and view().

     {
         $cmd = $this->ctrl->getCmd();
         switch ($cmd) {
             case self::CMD_STANDARD:
             case self::CMD_EXTRO:
                 $this->view($cmd);
                 break;
             case self::CMD_START:
                 $this->addMember($this->usr_id);
                 $this->ctrl->redirect($this, self::CMD_VIEW);
                 break;
             case self::CMD_UNSUBSCRIBE:
                 if ($this->userMayUnparticipate()) {
                     $this->roles->leave($this->usr_id);
                 }
                 $this->ctrl->redirect($this, self::CMD_STANDARD);
                 break;
             case self::CMD_VIEW:
                 $this->play();
                 break;
 
             case LSControlBuilder::CMD_CHECK_CURRENT_ITEM_LP:
                 $this->getCurrentItemLearningProgress();
 
                 // no break
             default:
                 throw new ilException(
                     "ilObjLearningSequenceLearnerGUI: " .
                     "Command not supported: $cmd"
                 );
         }
     }

Here is the call graph for this function:

◆ getCurrentItemLearningProgress()

ilObjLearningSequenceLearnerGUI::getCurrentItemLearningProgress ( )

protected

Definition at line 233 of file class.ilObjLearningSequenceLearnerGUI.php.

References exit.

Referenced by executeCommand().

     {
         print $this->player->getCurrentItemLearningProgress();
         exit;
     }

Here is the caller graph for this function:

◆ getMainContent()

ilObjLearningSequenceLearnerGUI::getMainContent ( string $cmd )

private

Definition at line 185 of file class.ilObjLearningSequenceLearnerGUI.php.

References $img, $txt, and settings().

Referenced by view().

                                                  : array
     {
         if ($cmd === self::CMD_STANDARD) {
             $txt = $this->settings->getAbstract();
             $img = $this->settings->getAbstractImage();
         }
 
         if ($cmd === self::CMD_EXTRO) {
             $txt = $this->settings->getExtro();
             $img = $this->settings->getExtroImage();
         }
 
         $contents = [$this->ui_factory->legacy($txt)];
         if (!is_null($img)) {
             $contents[] = $this->ui_factory->image()->responsive($img, '');
         }
 
         return $contents;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWrappedHTML()

ilObjLearningSequenceLearnerGUI::getWrappedHTML ( array $components )

private

Definition at line 174 of file class.ilObjLearningSequenceLearnerGUI.php.

Referenced by view().

                                                        : string
     {
         array_unshift(
             $components,
             $this->ui_factory->legacy('<div class="ilLSOLearnerView">')
         );
         $components[] = $this->ui_factory->legacy('</div>');
 
         return $this->renderer->render($components);
     }

Here is the caller graph for this function:

◆ initToolbar()

ilObjLearningSequenceLearnerGUI::initToolbar ( string $cmd )

protected

Definition at line 120 of file class.ilObjLearningSequenceLearnerGUI.php.

References ilLinkButton\getInstance(), userMayJoin(), and userMayUnparticipate().

Referenced by view().

     {
         $is_member = $this->roles->isMember($this->usr_id);
         $completed = $this->roles->isCompletedByUser($this->usr_id);
 
         if (!$is_member) {
             $may_subscribe = $this->userMayJoin();
             if ($may_subscribe) {
                 $sub_button = ilLinkButton::getInstance();
                 $sub_button->setPrimary(true);
                 $sub_button->setCaption("lso_player_start");
                 $sub_button->setUrl($this->ctrl->getLinkTarget($this,self::CMD_START));
                 $this->toolbar->addButtonInstance($sub_button);
             }
         } else {
             if (!$completed) {
                 $res_button = ilLinkButton::getInstance();
                 $res_button->setPrimary(true);
                 $res_button->setCaption("lso_player_resume");
                 if ($this->first_access === -1) {
                     $res_button->setCaption("lso_player_start");
                 }
                 $res_button->setUrl($this->ctrl->getLinkTarget($this, self::CMD_VIEW));
                 $this->toolbar->addButtonInstance($res_button);
             } else {
                 $review_button = ilLinkButton::getInstance();
                 $review_button->setCaption("lso_player_review");
                 $review_button->setUrl($this->ctrl->getLinkTarget($this, self::CMD_VIEW));
                 $this->toolbar->addButtonInstance($review_button);
 
                 if ($cmd === self::CMD_STANDARD) {
                     $button = ilLinkButton::getInstance();
                     $button->setCaption("lso_player_extro");
                     $button->setUrl($this->ctrl->getLinkTarget($this, self::CMD_EXTRO));
                     $this->toolbar->addButtonInstance($button);
                 }
                 if ($cmd === self::CMD_EXTRO) {
                     $button = ilLinkButton::getInstance();
                     $button->setCaption("lso_player_abstract");
                     $button->setUrl($this->ctrl->getLinkTarget($this, self::CMD_STANDARD));
                     $this->toolbar->addButtonInstance($button);
                 }
             }
 
             $may_unsubscribe = $this->userMayUnparticipate();
             if ($may_unsubscribe) {
                 $unsub_button = ilLinkButton::getInstance();
                 $unsub_button->setCaption("unparticipate");
                 $unsub_button->setUrl($this->ctrl->getLinkTarget($this, self::CMD_UNSUBSCRIBE));
                 $this->toolbar->addButtonInstance($unsub_button);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ play()

ilObjLearningSequenceLearnerGUI::play ( )

protected

Definition at line 205 of file class.ilObjLearningSequenceLearnerGUI.php.

References $_GET, $_POST, $response, ilLSPlayer\LSO_CMD_FINISH, ilLSPlayer\LSO_CMD_SUSPEND, ilUtil\redirect(), ilLSPlayer\RET_EXIT, ilLSPlayer\RET_NOITEMS, and ilUtil\sendInfo().

Referenced by executeCommand().

     {
         $response = $this->player->play($_GET, $_POST);
 
         switch ($response) {
             case null:
                 $this->tpl->enableDragDropFileUpload(null);
                 $this->tpl->setContent('THIS SHOULD NOT SHOW');
                 return;
             
             case ilLSPlayer::RET_NOITEMS:
                 \ilUtil::sendInfo($this->lng->txt('container_no_items'));
                 $this->tpl->setContent('');
                 return;
 
             case ilLSPlayer::RET_EXIT . ilLSPlayer::LSO_CMD_FINISH:
                 $cmd = self::CMD_EXTRO;
                 break;
 
             case ilLSPlayer::RET_EXIT . ilLSPlayer::LSO_CMD_SUSPEND:
             default:
                 $cmd = self::CMD_STANDARD;
                 break;
         }
         $href = $this->ctrl->getLinkTarget($this, $cmd, '', false, false);
         \ilUtil::redirect($href);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ userMayJoin()

ilObjLearningSequenceLearnerGUI::userMayJoin ( )

protected

Definition at line 115 of file class.ilObjLearningSequenceLearnerGUI.php.

Referenced by initToolbar().

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

Here is the caller graph for this function:

◆ userMayUnparticipate()

ilObjLearningSequenceLearnerGUI::userMayUnparticipate ( )

protected

Definition at line 110 of file class.ilObjLearningSequenceLearnerGUI.php.

Referenced by executeCommand(), and initToolbar().

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

Here is the caller graph for this function:

◆ view()

ilObjLearningSequenceLearnerGUI::view ( string $cmd )

protected

Definition at line 84 of file class.ilObjLearningSequenceLearnerGUI.php.

References getMainContent(), getWrappedHTML(), and initToolbar().

Referenced by executeCommand().

     {
         $this->initToolbar($cmd);
         
         $content = $this->getMainContent($cmd);
         $this->tpl->setContent(
             $this->getWrappedHTML($content)
         );
         
         $curriculum = $this->curriculum_builder->getLearnerCurriculum();
         if (count($curriculum->getSteps()) > 0) {
             $this->tpl->setRightContent(
                 $this->getWrappedHTML([$curriculum])
             );
         }
     }