Collaboration diagram for ilObjLearningSequenceLearnerGUI:

Public Member Functions
	__construct (protected int $usr_id, protected ilAccess $access, protected ilCtrl $ctrl, protected ilLanguage $lng, protected ilGlobalTemplateInterface $tpl, protected ilToolbarGUI $toolbar, protected ILIAS\UI\Factory $ui_factory, protected ILIAS\UI\Renderer $renderer, protected ilLearningSequenceRoles $roles, protected ilLearningSequenceSettings $settings, protected ilLSCurriculumBuilder $curriculum_builder, protected ilLSLaunchlinksBuilder $launchlinks_builder, protected ilLSPlayer $player, protected string $intro, protected string $extro, protected RequestWrapper $get)

	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)

	initToolbar (string $cmd)

	play ()

Private Member Functions
	getWrappedHTML (array $components)

	getMainContent (string $cmd)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjLearningSequenceLearnerGUI::__construct	(	protected int	$usr_id,
		protected ilAccess	$access,
		protected ilCtrl	$ctrl,
		protected ilLanguage	$lng,
		protected ilGlobalTemplateInterface	$tpl,
		protected ilToolbarGUI	$toolbar,
		protected ILIAS\UI\Factory	$ui_factory,
		protected ILIAS\UI\Renderer	$renderer,
		protected ilLearningSequenceRoles	$roles,
		protected ilLearningSequenceSettings	$settings,
		protected ilLSCurriculumBuilder	$curriculum_builder,
		protected ilLSLaunchlinksBuilder	$launchlinks_builder,
		protected ilLSPlayer	$player,
		protected string	$intro,
		protected string	$extro,
		protected RequestWrapper	$get
	)

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

51 {

52 }

Member Function Documentation

◆ addMember()

ilObjLearningSequenceLearnerGUI::addMember ( int $usr_id )

protected

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

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

Referenced by executeCommand().

Here is the caller graph for this function:

◆ executeCommand()

ilObjLearningSequenceLearnerGUI::executeCommand ( )

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

                                    : void
    {
        $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->launchlinks_builder->currentUserMayUnparticipate()) {
                    $this->roles->leave($this->usr_id);
                }
                $this->ctrl->redirect($this, self::CMD_STANDARD);
                break;
            case self::CMD_VIEW:
                $this->play();
                break;
 
            default:
                throw new ilException(
                    "ilObjLearningSequenceLearnerGUI: " .
                    "Command not supported: $cmd"
                );
        }
    }

References addMember(), CMD_EXTRO, CMD_STANDARD, CMD_START, CMD_UNSUBSCRIBE, CMD_VIEW, ILIAS\Repository\ctrl(), play(), and view().

Here is the call graph for this function:

◆ getMainContent()

ilObjLearningSequenceLearnerGUI::getMainContent ( string $cmd )

private

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

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

References ILIAS\Repository\settings().

Referenced by view().

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 128 of file class.ilObjLearningSequenceLearnerGUI.php.

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

References $components, and renderer().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initToolbar()

ilObjLearningSequenceLearnerGUI::initToolbar ( string $cmd )

protected

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

    {
        foreach ($this->launchlinks_builder->getLinks() as $entry) {
            list($label, $link, $primary) = $entry;
 
            if ($primary) {
                $btn = $this->ui_factory->button()->primary($label, $link);
            } else {
                $btn = $this->ui_factory->button()->standard($label, $link);
            }
            $this->toolbar->addComponent($btn);
        }
    }

References ILIAS\Repository\toolbar().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ play()

ilObjLearningSequenceLearnerGUI::play ( )

protected

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

                             : void
    {
        $response = $this->player->play($this->get);
 
        switch ($response) {
            case null:
                //render the page
                $this->tpl->setContent($this->lng->txt('lso_player_noitems'));
                return;
 
            case 'EXIT::' . $this->player::LSO_CMD_FINISH:
                $cmd = self::CMD_EXTRO;
                break;
 
            case 'EXIT::' . $this->player::LSO_CMD_SUSPEND:
            default:
                $cmd = self::CMD_STANDARD;
                break;
        }
        $href = $this->ctrl->getLinkTarget($this, $cmd, '', false, false);
        \ilUtil::redirect($href);
    }

References $response, CMD_EXTRO, CMD_STANDARD, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilUtil\redirect().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view()

ilObjLearningSequenceLearnerGUI::view ( string $cmd )

protected

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

                                        : void
    {
        $content = $this->getWrappedHTML(
            $this->getMainContent($cmd)
        );
 
        $this->tpl->setContent($content);
 
        $element = '<' . ilPCLauncher::PCELEMENT . '>';
        if (!str_contains($content, $element)) {
            $this->initToolbar($cmd);
        }
 
        $element = '<' . ilPCCurriculum::PCELEMENT . '>';
        if (!str_contains($content, $element)) {
            $curriculum = $this->curriculum_builder->getLearnerCurriculum();
            $this->tpl->setRightContent(
                $this->getWrappedHTML([$curriculum])
            );
        }
    }