Class ilObjLearningSequenceLearnerGUI. More...

Collaboration diagram for ilObjLearningSequenceLearnerGUI:

Public Member Functions
	__construct (ilObjLearningSequence $ls_object, int $usr_id, array $ls_learner_items, int $current_item, ilCtrl $ctrl, ilLanguage $lng, ilTemplate $tpl, ilToolbarGUI $toolbar, ILIAS\UI\Factory $ui_factory, ILIAS\UI\Renderer $ui_renderer)

	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)

	removeMember (int $usr_id)

	initToolbar (string $cmd)

	play ()

Protected Attributes
	$ls_learner_items

Private Member Functions
	getWrappedHTML (array $components)

	getCurriculum ()

	getMainContent (string $cmd)

Detailed Description

Class ilObjLearningSequenceLearnerGUI.

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

Constructor & Destructor Documentation

◆ __construct()

ilObjLearningSequenceLearnerGUI::__construct	(	ilObjLearningSequence	$ls_object,
		int	$usr_id,
		array	$ls_learner_items,
		int	$current_item,
		ilCtrl	$ctrl,
		ilLanguage	$lng,
		ilTemplate	$tpl,
		ilToolbarGUI	$toolbar,
		ILIAS\UI\Factory	$ui_factory,
		ILIAS\UI\Renderer	$ui_renderer
	)

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

      {
        $this->ls_object = $ls_object;
        $this->usr_id = $usr_id;
        $this->ls_learner_items = $ls_learner_items;
        $this->current_item = $current_item;
        $this->ctrl = $ctrl;
        $this->lng = $lng;
        $this->tpl = $tpl;
        $this->toolbar = $toolbar;
        $this->ui_factory = $ui_factory;
        $this->renderer = $ui_renderer;
    }

References $lng, $ls_learner_items, and $tpl.

Member Function Documentation

◆ addMember()

ilObjLearningSequenceLearnerGUI::addMember ( int $usr_id )

protected

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

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

Referenced by executeCommand().

Here is the caller graph for this function:

◆ executeCommand()

ilObjLearningSequenceLearnerGUI::executeCommand ( )

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

    {
        $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->ls_object->userMayUnparticipate()) {
                    $this->removeMember($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, play(), removeMember(), and view().

Here is the call graph for this function:

◆ getCurriculum()

ilObjLearningSequenceLearnerGUI::getCurriculum ( )

private

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

                                     : array
    {
        $current_position = 0;
        foreach ($this->ls_learner_items as $index => $item) {
            if ($item->getRefId() === $this->current_item) {
                $current_position = $index;
            }
        }
 
        $curriculum = $this->ls_object
            ->getCurriculumBuilder($this->ls_learner_items)
            ->getLearnerCurriculum();
 
        if (count($this->ls_learner_items) > 0) {
            $curriculum = $curriculum->withActive($current_position);
        }
        return array($curriculum);
    }

References $index.

Referenced by view().

Here is the caller graph for this function:

◆ getMainContent()

ilObjLearningSequenceLearnerGUI::getMainContent ( string $cmd )

private

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

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

References $img, and $txt.

Referenced by view().

Here is the caller graph for this function:

◆ getWrappedHTML()

ilObjLearningSequenceLearnerGUI::getWrappedHTML ( array $components )

private

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

    {
        $is_member = $this->ls_object->isMember($this->usr_id);
        $completed = $this->ls_object->isCompletedByUser($this->usr_id);
        $has_items = count($this->ls_learner_items) > 0;
 
        if (!$is_member) {
            if ($has_items) {
                $may_subscribe = $this->ls_object->userMayJoin();
                if ($may_subscribe) {
                    $this->toolbar->addButton(
                        $this->lng->txt("lso_player_start"),
                        $this->ctrl->getLinkTarget($this, self::CMD_START)
                    );
                }
            }
        } else {
            if (!$completed) {
                if ($has_items) {
                    $state_db = $this->ls_object->getStateDB();
                    $obj_ref_id = (int) $this->ls_object->getRefId();
                    $first_access = $state_db->getFirstAccessFor(
                        $obj_ref_id,
                        array($this->usr_id)
                    )[$this->usr_id];
 
                    $label = "lso_player_resume";
                    if ($first_access === -1) {
                        $label = "lso_player_start";
                    }
 
                    $this->toolbar->addButton(
                        $this->lng->txt($label),
                        $this->ctrl->getLinkTarget($this, self::CMD_VIEW)
                    );
                }
            } else {
                if ($has_items) {
                    $this->toolbar->addButton(
                        $this->lng->txt("lso_player_review"),
                        $this->ctrl->getLinkTarget($this, self::CMD_VIEW)
                    );
                }
                if ($cmd === self::CMD_STANDARD) {
                    $this->toolbar->addButton(
                        $this->lng->txt("lso_player_extro"),
                        $this->ctrl->getLinkTarget($this, self::CMD_EXTRO)
                    );
                }
                if ($cmd === self::CMD_EXTRO) {
                    $this->toolbar->addButton(
                        $this->lng->txt("lso_player_abstract"),
                        $this->ctrl->getLinkTarget($this, self::CMD_STANDARD)
                    );
                }
            }
 
            $may_unsubscribe = $this->ls_object->userMayUnparticipate();
            if ($may_unsubscribe) {
                $this->toolbar->addButton(
                    $this->lng->txt("unparticipate"),
                    $this->ctrl->getLinkTarget($this, self::CMD_UNSUBSCRIBE)
                );
            }
        }
    }

Referenced by view().

Here is the caller graph for this function:

◆ play()

ilObjLearningSequenceLearnerGUI::play ( )

protected

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

    {
        //enforce tree is visible/active for ToC
        //(this does not work for first item, since there is no page-change)
        //how is this done?
 
        if (!$_SESSION["lso_old_il_rep_mode"]) {
            $_SESSION["lso_old_il_rep_mode"] = $_SESSION["il_rep_mode"];
        }
        $_SESSION["il_rep_mode"] = 'tree';
 
 
        $player = $this->ls_object->getSequencePlayer(
            $this,
            self::CMD_VIEW,
            $this->usr_id
        );
        $html = $player->render($_GET, $_POST);
 
        if ($html === 'EXIT::' . $player::LSO_CMD_SUSPEND) {
            $cmd = self::CMD_STANDARD;
        }
        if ($html === 'EXIT::' . $player::LSO_CMD_FINISH) {
            $cmd = self::CMD_EXTRO;
        }
        if (is_null($html)) {
            $cmd = self::CMD_STANDARD;
        }
 
        if (is_null($cmd)) {
            print $html;
            exit();
        } else {
            $_SESSION["il_rep_mode"] = $_SESSION["lso_old_il_rep_mode"];
 
            $href = $this->ctrl->getLinkTarget($this, $cmd, '', false, false);
            \ilUtil::redirect($href);
        }
    }

References $_GET, $_POST, $_SESSION, $html, CMD_EXTRO, CMD_STANDARD, exit, print, and ilUtil\redirect().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeMember()

ilObjLearningSequenceLearnerGUI::removeMember ( int $usr_id )

protected

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

    {
        $this->ls_object->leave($usr_id);
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ view()

ilObjLearningSequenceLearnerGUI::view ( string $cmd )

protected

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

    {
        $content = $this->getWrappedHTML($this->getMainContent($cmd));
        $curriculum = $this->getWrappedHTML($this->getCurriculum());
 
        $this->initToolbar($cmd);
        $this->tpl->setContent($content);
        $this->tpl->setRightContent($curriculum);
    }