ilObjLearningSequenceLearnerGUI Class Reference

@ilCtrl_Calls ilObjLearningSequenceLearnerGUI: ilCommonActionDispatcherGUI More...

Inheritance diagram for ilObjLearningSequenceLearnerGUI:

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 ilLSLaunchlinksBuilder $launchlinks_builder, protected ilLSLearnerItemsQueries $ls_items, protected ilLSPlayer $player, protected string $intro, protected string $extro, protected RequestWrapper $get)
	getUnsafeGetCommands ()
	Joining and leaving the learning sequence are triggered by links (launch button, interruptive modal action) and therefore need to be protected by an ilCtrl CSRF token. More...
	getSafePostCommands ()
	@inheritDoc More...
	executeCommand ()
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Data Fields
const	CMD_SAVE_RATING = 'saveRating'
const	CMD_REDRAW_LIST_ITEM = 'redrawListItem'
const	CMD_STANDARD = 'learnerView'
const	CMD_EXTRO = 'learnerViewFinished'
const	CMD_UNSUBSCRIBE_CONFIRMATION = 'unsubscribeConfirmation'
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
	executeCommandByCommand (string $cmd)
	redrawListItem ()
	isRatingListItemInCurrentLearningSequence (int $child_ref_id, int $parent_ref_id)
	unsubscribeConfirmationModal ()
	view (string $cmd)
	addMember (int $usr_id)
	initToolbar (string $cmd, Interruptive $modal)
	play ()

Private Member Functions
	getWrappedHTML (array $components)
	getMainContent (string $cmd)

Detailed Description

@ilCtrl_Calls ilObjLearningSequenceLearnerGUI: ilCommonActionDispatcherGUI

Definition at line 29 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 ilLSLaunchlinksBuilder	$launchlinks_builder,
		protected ilLSLearnerItemsQueries	$ls_items,
		protected ilLSPlayer	$player,
		protected string	$intro,
		protected string	$extro,
		protected RequestWrapper	$get
	)

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

      {
    }

Member Function Documentation

addMember()

ilObjLearningSequenceLearnerGUI::addMember ( int  $usr_id )

protected

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

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

Referenced by executeCommandByCommand().

Here is the caller graph for this function:

executeCommand()

ilObjLearningSequenceLearnerGUI::executeCommand

(

)

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

                                    : void
    {
        // ilCtrl returns no command if the CSRF validation fails, fall back
        // to the learner view in this case.
        $cmd = $this->ctrl->getCmd(self::CMD_STANDARD);
        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            case strtolower(ilCommonActionDispatcherGUI::class):
                $dispatcher = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                if ($dispatcher instanceof ilCommonActionDispatcherGUI) {
                    $this->ctrl->forwardCommand($dispatcher);
                }
                break;
            default:
                $this->executeCommandByCommand($cmd);
        }
    }

References ILIAS\Repository\ctrl(), executeCommandByCommand(), and ilCommonActionDispatcherGUI\getInstanceFromAjaxCall().

Here is the call graph for this function:

executeCommandByCommand()

ilObjLearningSequenceLearnerGUI::executeCommandByCommand ( string  $cmd )

protected

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

                                                           : void
    {
        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_CONFIRMATION:
                $this->unsubscribeConfirmationModal();
                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_REDRAW_LIST_ITEM:
                $this->redrawListItem();
                break;
            case self::CMD_VIEW:
                $this->play();
                break;
 
            default:
                throw new ilException(
                    "ilObjLearningSequenceLearnerGUI: " .
                    "Command not supported: $cmd"
                );
        }
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

getMainContent()

ilObjLearningSequenceLearnerGUI::getMainContent ( string  $cmd )

private

Definition at line 331 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 $contents, and ILIAS\Repository\settings().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

getSafePostCommands()

ilObjLearningSequenceLearnerGUI::getSafePostCommands

(

)

@inheritDoc

Implements ilCtrlSecurityInterface.

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

                                         : array
    {
        return [];
    }

getUnsafeGetCommands()

ilObjLearningSequenceLearnerGUI::getUnsafeGetCommands

(

)

Joining and leaving the learning sequence are triggered by links (launch button, interruptive modal action) and therefore need to be protected by an ilCtrl CSRF token.

@inheritDoc

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return [
            self::CMD_START,
            self::CMD_UNSUBSCRIBE,
        ];
    }

References CMD_START, and CMD_UNSUBSCRIBE.

getWrappedHTML()

ilObjLearningSequenceLearnerGUI::getWrappedHTML ( array  $components )

private

Definition at line 320 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, Interruptive  $modal  )

protected

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

                                                                    : void
    {
        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);
            }
 
            if ($label === $this->lng->txt("unparticipate")) {
                $btn = $this->ui_factory->button()->standard($label, $link)->withOnClick($modal->getShowSignal());
            }
 
            $this->toolbar->addComponent($btn);
        }
    }

References ILIAS\UI\Component\Modal\Modal\getShowSignal(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

isRatingListItemInCurrentLearningSequence()

ilObjLearningSequenceLearnerGUI::isRatingListItemInCurrentLearningSequence ( int  $child_ref_id, int  $parent_ref_id  )

protected

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

                                                                                                       : bool
    {
        if ($parent_ref_id !== $this->ls_items->getLearningSequenceRefId()) {
            return false;
        }
 
        foreach ($this->ls_items->getItems() as $item) {
            if ($item->getRefId() === $child_ref_id) {
                return true;
            }
        }
 
        return false;
    }

Referenced by redrawListItem().

Here is the caller graph for this function:

play()

ilObjLearningSequenceLearnerGUI::play ( )

protected

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

                             : void
    {
        $response = $this->player->play($this->get);
 
        if ($response !== null && str_starts_with($response, $this->player::REDIRECT_PREFIX)) {
            $this->ctrl->redirectToURL(substr($response, strlen($this->player::REDIRECT_PREFIX)));
        }
 
        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 executeCommandByCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

redrawListItem()

ilObjLearningSequenceLearnerGUI::redrawListItem ( )

protected

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

                                       : void
    {
        global $DIC;
 
        $http = $DIC->http();
        $response = $http->response();
 
        $child_ref_id = (int) $this->get->retrieve('child_ref_id', $DIC->refinery()->kindlyTo()->int());
        $parent_ref_id = (int) $this->get->retrieve('parent_ref_id', $DIC->refinery()->kindlyTo()->int());
 
        if ($child_ref_id <= 0 || $parent_ref_id <= 0) {
            $http->saveResponse(
                $response
                    ->withBody(Streams::ofString(''))
                    ->withHeader(ResponseHeader::CONTENT_TYPE, 'text/html; charset=UTF-8')
            );
            $http->sendResponse();
            $http->close();
            return;
        }
 
        if (!$this->isRatingListItemInCurrentLearningSequence($child_ref_id, $parent_ref_id)) {
            $http->saveResponse(
                $response
                    ->withBody(Streams::ofString(''))
                    ->withHeader(ResponseHeader::CONTENT_TYPE, 'text/html; charset=UTF-8')
            );
            $http->sendResponse();
            $http->close();
            return;
        }
 
        $obj_id = ilObject::_lookupObjId($child_ref_id);
        if ($obj_id <= 0) {
            $http->saveResponse(
                $response
                    ->withBody(Streams::ofString(''))
                    ->withHeader(ResponseHeader::CONTENT_TYPE, 'text/html; charset=UTF-8')
            );
            $http->sendResponse();
            $http->close();
            return;
        }
 
        $obj_type = ilObject::_lookupType($obj_id);
        if ($obj_type === '') {
            $http->saveResponse(
                $response
                    ->withBody(Streams::ofString(''))
                    ->withHeader(ResponseHeader::CONTENT_TYPE, 'text/html; charset=UTF-8')
            );
            $http->sendResponse();
            $http->close();
            return;
        }
 
        ilRating::preloadListGUIData([$obj_id]);
        if (!ilRating::hasRatingInListGUI($obj_id, $obj_type)) {
            $http->saveResponse(
                $response
                    ->withBody(Streams::ofString(''))
                    ->withHeader(ResponseHeader::CONTENT_TYPE, 'text/html; charset=UTF-8')
            );
            $http->sendResponse();
            $http->close();
            return;
        }
 
        $ajax_hash = ilCommonActionDispatcherGUI::buildAjaxHash(
            ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            $child_ref_id,
            $obj_type,
            $obj_id
        );
 
        $rating_gui = (new ilRatingGUI())->withAsyncRendering(true);
        $rating_gui->setObject($obj_id, $obj_type);
        $rating_gui->setCtrlPath([
            ilCommonActionDispatcherGUI::class,
            ilRatingGUI::class
        ]);
        $rating_gui->setYourRatingText($this->lng->txt('rating_your_rating'));
 
        $container_id = 'lg_div_' . $child_ref_id . '_pref_' . $parent_ref_id;
        $rating_content = $rating_gui->getListGUIProperty(
            $child_ref_id,
            $this->access->checkAccess('read', '', $child_ref_id),
            $ajax_hash,
            $parent_ref_id
        );
 
        $tpl = new ilTemplate(
            'tpl.lso_kiosk_rating_container.html',
            true,
            true,
            'components/ILIAS/LearningSequence'
        );
        $tpl->setVariable('CONTAINER_ID', $container_id);
        $tpl->setVariable('CHILD_REF_ID', (string) $child_ref_id);
        $tpl->setVariable('AJAX_HASH', htmlspecialchars($ajax_hash, ENT_QUOTES));
        $tpl->setVariable('RATING_CONTENT', $rating_content);
        $html = $tpl->get();
 
        $http->saveResponse(
            $response
                ->withBody(Streams::ofString($html))
                ->withHeader(ResponseHeader::CONTENT_TYPE, 'text/html; charset=UTF-8')
        );
        $http->sendResponse();
        $http->close();
        return;
    }

References $DIC, ILIAS\BookingManager\Common\Table\$http, $response, ILIAS\News\Common\Table\$tpl, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\access(), ilCommonActionDispatcherGUI\buildAjaxHash(), ILIAS\GlobalScreen\get(), ILIAS\UICore\GlobalTemplate\get(), ilRating\hasRatingInListGUI(), ILIAS\Repository\int(), isRatingListItemInCurrentLearningSequence(), ILIAS\Repository\lng(), ilRating\preloadListGUIData(), ILIAS\UICore\GlobalTemplate\setVariable(), and ilCommonActionDispatcherGUI\TYPE_REPOSITORY.

Referenced by executeCommandByCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

unsubscribeConfirmationModal()

ilObjLearningSequenceLearnerGUI::unsubscribeConfirmationModal ( )

protected

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

                                                     : Interruptive
    {
        return $this->ui_factory->modal()->interruptive(
            $this->lng->txt('obj_lso'),
            $this->lng->txt("unparticipate"),
            $this->ctrl->getLinkTarget($this, self::CMD_UNSUBSCRIBE),
        );
    }

References ILIAS\Repository\lng().

Referenced by executeCommandByCommand(), and view().

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

                                        : void
    {
        $content = $this->getWrappedHTML(
            $this->getMainContent($cmd)
        );
 
        $modal = $this->unsubscribeConfirmationModal();
 
        $this->tpl->setContent($content . $this->renderer->render($modal));
 
        $element = '<' . ilPCLauncher::PCELEMENT . '>';
        if (!str_contains($content, $element)) {
            $this->initToolbar($cmd, $modal);
        }
    }

References getMainContent(), getWrappedHTML(), initToolbar(), ilPCLauncher\PCELEMENT, renderer(), and unsubscribeConfirmationModal().

Referenced by executeCommandByCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

CMD_EXTRO

const ilObjLearningSequenceLearnerGUI::CMD_EXTRO = 'learnerViewFinished'

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

Referenced by executeCommandByCommand(), and play().

CMD_REDRAW_LIST_ITEM

const ilObjLearningSequenceLearnerGUI::CMD_REDRAW_LIST_ITEM = 'redrawListItem'

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

Referenced by executeCommandByCommand(), and ilLSPlayer\play().

CMD_SAVE_RATING

const ilObjLearningSequenceLearnerGUI::CMD_SAVE_RATING = 'saveRating'

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

CMD_STANDARD

const ilObjLearningSequenceLearnerGUI::CMD_STANDARD = 'learnerView'

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

Referenced by executeCommandByCommand(), and play().

CMD_START

const ilObjLearningSequenceLearnerGUI::CMD_START = 'start'

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

Referenced by executeCommandByCommand(), and getUnsafeGetCommands().

CMD_UNSUBSCRIBE

const ilObjLearningSequenceLearnerGUI::CMD_UNSUBSCRIBE = 'unsubscribe'

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

Referenced by executeCommandByCommand(), and getUnsafeGetCommands().

CMD_UNSUBSCRIBE_CONFIRMATION

const ilObjLearningSequenceLearnerGUI::CMD_UNSUBSCRIBE_CONFIRMATION = 'unsubscribeConfirmation'

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

Referenced by executeCommandByCommand().

CMD_VIEW

const ilObjLearningSequenceLearnerGUI::CMD_VIEW = 'view'

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

Referenced by executeCommandByCommand().

LSO_CMD_NEXT

const ilObjLearningSequenceLearnerGUI::LSO_CMD_NEXT = 'lson'

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

LSO_CMD_PREV

const ilObjLearningSequenceLearnerGUI::LSO_CMD_PREV = 'lsop'

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

PARAM_LSO_NEXT_ITEM

const ilObjLearningSequenceLearnerGUI::PARAM_LSO_NEXT_ITEM = 'lsoni'

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

---

The documentation for this class was generated from the following file:

• components/ILIAS/LearningSequence/classes/Player/class.ilObjLearningSequenceLearnerGUI.php