Collaboration diagram for ilObjLearningSequenceLearnerGUI:

Public Member Functions
	__construct (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, ilLSLaunchlinksBuilder $launchlinks_builder, ilLSPlayer $player, string $intro, string $extro, 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 ()

Protected Attributes
ilAccess	$access

ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilToolbarGUI	$toolbar

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$renderer

ilLearningSequenceRoles	$roles

ilLearningSequenceSettings	$settings

ilLSCurriculumBuilder	$curriculum_builder

ilLSLaunchlinksBuilder	$launchlinks_builder

ilLSPlayer	$player

string	$intro

string	$extro

RequestWrapper	$get

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	(	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,
		ilLSLaunchlinksBuilder	$launchlinks_builder,
		ilLSPlayer	$player,
		string	$intro,
		string	$extro,
		RequestWrapper	$get
	)

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

      {
        $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->launchlinks_builder = $launchlinks_builder;
        $this->player = $player;
        $this->intro = $intro;
        $this->extro = $extro;
        $this->get = $get;
    }

References $access, $ctrl, $curriculum_builder, $extro, $get, $intro, $launchlinks_builder, $lng, $player, $roles, $settings, $toolbar, $tpl, $ui_factory, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ addMember()

ilObjLearningSequenceLearnerGUI::addMember ( int $usr_id )

protected

Definition at line 140 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 88 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 171 of file class.ilObjLearningSequenceLearnerGUI.php.

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

References $img, and 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 160 of file class.ilObjLearningSequenceLearnerGUI.php.

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

Referenced by view().

Here is the caller graph for this function:

◆ initToolbar()

ilObjLearningSequenceLearnerGUI::initToolbar ( string $cmd )

protected

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

    {
        foreach ($this->launchlinks_builder->getLinks() as $entry) {
            list($label, $link, $primary) = $entry;
            $sub_button = ilLinkButton::getInstance();
            $sub_button->setPrimary($primary);
            $sub_button->setCaption($label, false);
            $sub_button->setUrl($link);
            $this->toolbar->addButtonInstance($sub_button);
        }
    }

References ilLinkButton\getInstance(), and 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 202 of file class.ilObjLearningSequenceLearnerGUI.php.

                             : void
    {
        $response = $this->player->play($this->get);
 
        switch ($response) {
            case null:
                //render the page
                $this->tpl->setContent('THIS SHOULD NOT SHOW');
                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(), 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 118 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])
            );
        }
    }