ilLearningModuleKioskModeView Class Reference

Class ilLearningModuleKioskModeView. More...

Inheritance diagram for ilLearningModuleKioskModeView:

Collaboration diagram for ilLearningModuleKioskModeView:

Public Member Functions
	updateGet (State $state, string $command, int $param=null)
	@inheritDoc More...
	buildInitialState (State $state)
	@inheritDoc More...
	buildControls (State $state, ControlBuilder $builder)
	@inheritDoc More...
	updatePost (State $state, string $command, array $post)
	@inheritDoc More...
	render (State $state, Factory $factory, URLBuilder $url_builder, array $post=null)
	@inheritDoc More...
Public Member Functions inherited from ilKioskModeView
	__construct (\ilObject $object, \ilCtrl $ctrl, \ilLanguage $lng, \ilAccessHandler $access)
Public Member Functions inherited from ILIAS\KioskMode\View
	buildInitialState (State $empty_state)
	Build an initial state based on the Provided empty state. More...
	buildControls (State $state, ControlBuilder $builder)
	Construct the controls for the view based on the current state. More...
	updateGet (State $state, string $command, int $parameter=null)
	Update the state based on the provided command. More...
	updatePost (State $state, string $command, array $post)
	Update the state and the object based on the provided command and post-data. More...
	render (State $state, UI\Factory $factory, URLBuilder $url_builder, array $post=null)
	Render a state using the ui-factory and URLs from the builder. More...

Data Fields
const	CMD_TOGGLE_LEARNING_PROGRESS = 'toggleManualLearningProgress'

Protected Member Functions
	getObjectClass ()
	@inheritDoc More...
	setObject (\ilObject $object)
	@inheritDoc More...
	initLMService ($current_page)
	Init learning module presentation service. More...
	hasPermissionToAccessKioskMode ()
	@inheritDoc More...
	getMenuEntries ()
	maybeBuildLearningProgressToggleControl (ControlBuilder $builder)
	toggleLearningProgress (string $command)
	renderContentStyle ()
	Renders the content style of a ContentPage object into main template. More...
	getObjectClass ()
	Get the class of objects this view displays. More...
	setObject (\ilObject $object)
	Set the object for this view. More...
	hasPermissionToAccessKioskMode ()
	Check if the global user has permission to access the kiosk mode of the supplied object. More...

Protected Attributes
	$menu_entries = null
	$lm
	$lm_pres_service
	$lm_pres
	$user
	$uiFactory
	$uiRenderer
	$ctrl
	$mainTemplate
	$httpRequest
	$tabs
	$messages = []
	$current_page_id = 0
	$additional_content = []
Protected Attributes inherited from ilKioskModeView
	$ctrl
	$lng
	$access

Detailed Description

Class ilLearningModuleKioskModeView.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 19 of file class.ilLearningModuleKioskModeView.php.

Member Function Documentation

buildControls()

ilLearningModuleKioskModeView::buildControls	(	State	$state,
		ControlBuilder	$builder
	)

@inheritDoc

Implements ILIAS\KioskMode\View.

Definition at line 155 of file class.ilLearningModuleKioskModeView.php.

                                                                         : ControlBuilder
    {
        global $DIC;
 
        $main_tpl = $DIC->ui()->mainTemplate();
 
        // this may be necessary if updateGet has not been processed
 
        // THIS currently fails
        $this->initLMService($state->getValueFor("current_page"));
        $nav_stat = $this->lm_pres_service->getNavigationStatus();
 
        // next
        $succ_id = $nav_stat->getSuccessorPageId();
        if ($succ_id > 0) {
            $builder->next("layout", $succ_id);
        }
 
        // previous
        $prev_id = $nav_stat->getPredecessorPageId();
        if ($prev_id > 0) {
            $builder->previous("layout", $prev_id);
        }
 
        $toc = $builder->tableOfContent($this->lm->getTitle(), 'layout', 0);
        $lm_toc_renderer = new ilLMSlateTocRendererGUI($this->lm_pres_service);
        $lm_toc_renderer->renderLSToc($toc, $lm_toc_renderer, 0);
 
 
        // learning progress
        $builder = $this->maybeBuildLearningProgressToggleControl($builder);
 
        // menu
        foreach ($this->getMenuEntries() as $entry) {
            if (is_object($entry["signal"])) {
                $builder = $builder->genericWithSignal(
                    $entry["label"],
                    $entry["signal"]
                );
            }
            if ($entry["on_load"] != "") {
                $main_tpl->addOnLoadCode($entry["on_load"]);
            }
        }
 
        //$builder = $this->addPrintViewSelectionMenuButton($builder);
 
        return $builder;
    }

References $builder, $DIC, getMenuEntries(), ILIAS\KioskMode\State\getValueFor(), initLMService(), and maybeBuildLearningProgressToggleControl().

Here is the call graph for this function:

buildInitialState()

ilLearningModuleKioskModeView::buildInitialState

(

State

$state

)

@inheritDoc

Implements ILIAS\KioskMode\View.

Definition at line 147 of file class.ilLearningModuleKioskModeView.php.

                                                    : State
    {
        return $state->withValueFor("current_page", "");
    }

References ILIAS\KioskMode\State\withValueFor().

Here is the call graph for this function:

getMenuEntries()

ilLearningModuleKioskModeView::getMenuEntries ( )

protected

Parameters

return

Definition at line 211 of file class.ilLearningModuleKioskModeView.php.

                                        : array
    {
        if (is_null($this->menu_entries)) {
            $menu = new \ILIAS\LearningModule\Menu\ilLMMenuGUI($this->lm_pres_service);
            $this->menu_entries = $menu->getEntries();
        }
        return $this->menu_entries;
    }

References $menu_entries.

Referenced by buildControls().

Here is the caller graph for this function:

getObjectClass()

ilLearningModuleKioskModeView::getObjectClass ( )

protected

@inheritDoc

Reimplemented from ilKioskModeView.

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

                                        : string
    {
        return \ilObjLearningModule::class;
    }

hasPermissionToAccessKioskMode()

ilLearningModuleKioskModeView::hasPermissionToAccessKioskMode ( )

protected

@inheritDoc

Reimplemented from ilKioskModeView.

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

                                                        : bool
    {
        return $this->access->checkAccess('read', '', $this->lm->getRefId());
    }

initLMService()

ilLearningModuleKioskModeView::initLMService (   $current_page )

protected

Init learning module presentation service.

Definition at line 118 of file class.ilLearningModuleKioskModeView.php.

    {
        if (is_object($this->lm_pres)) {
            return;
        }
        $this->lm_pres = new ilLMPresentationGUI(
            "",
            false,
            "",
            false,
            ["ref_id" => $this->lm->getRefId(),
             "obj_id" => (int) $current_page],
            true
        );
 
        $this->lm_pres_service = $this->lm_pres->getService();
    }

Referenced by buildControls().

Here is the caller graph for this function:

maybeBuildLearningProgressToggleControl()

ilLearningModuleKioskModeView::maybeBuildLearningProgressToggleControl ( ControlBuilder  $builder )

protected

Parameters

ControlBuilder

$builder

Definition at line 223 of file class.ilLearningModuleKioskModeView.php.

                                                                                        : ControlBuilder
    {
        $learningProgress = \ilObjectLP::getInstance($this->lm->getId());
        if ($learningProgress->getCurrentMode() == \ilLPObjSettings::LP_MODE_MANUAL) {
            $isCompleted = \ilLPMarks::_hasCompleted($this->user->getId(), $this->lm->getId());
 
            $this->lng->loadLanguageModule('lm');
            $learningProgressToggleCtrlLabel = $this->lng->txt('lm_btn_lp_toggle_state_completed');
            if (!$isCompleted) {
                $learningProgressToggleCtrlLabel = $this->lng->txt('lm_btn_lp_toggle_state_not_completed');
            }
            $builder = $builder->generic(
                $learningProgressToggleCtrlLabel,
                self::CMD_TOGGLE_LEARNING_PROGRESS,
                1
            );
        }
        return $builder;
    }

References $builder, ilLPMarks\_hasCompleted(), ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_MANUAL, and user().

Referenced by buildControls().

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilLearningModuleKioskModeView::render	(	State	$state,
		Factory	$factory,
		URLBuilder	$url_builder,
		array	$post = null
	)

@inheritDoc

Definition at line 276 of file class.ilLearningModuleKioskModeView.php.

      : Component {
        $this->initLMService($state->getValueFor("current_page"));
 
        $additional_content = [];
        foreach ($this->getMenuEntries() as $entry) {
            if (is_object($entry["modal"])) {
                $additional_content[] = $entry["modal"];
            }
        }
 
        $this->ctrl->setParameterByClass("illmpresentationgui", 'ref_id', $this->lm->getRefId());
        $content = $this->uiRenderer->render($this->messages);
        $content .= $this->ctrl->getHTML($this->lm_pres, ["cmd" => "layout"], ["illmpresentationgui"]);
        $content .= $this->uiRenderer->render($additional_content);
        return $factory->legacy($content);
    }

References $additional_content.

renderContentStyle()

ilLearningModuleKioskModeView::renderContentStyle ( )

protected

Renders the content style of a ContentPage object into main template.

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

    {
        $this->mainTemplate->addCss(\ilObjStyleSheet::getSyntaxStylePath());
        $this->mainTemplate->addCss(
            \ilObjStyleSheet::getContentStylePath(
                $this->contentPageObject->getStyleSheetId()
            )
        );
    }

References ilObjStyleSheet\getContentStylePath(), and ilObjStyleSheet\getSyntaxStylePath().

Here is the call graph for this function:

setObject()

ilLearningModuleKioskModeView::setObject ( \ilObject  $object )

protected

@inheritDoc

Reimplemented from ilKioskModeView.

Definition at line 79 of file class.ilLearningModuleKioskModeView.php.

    {
        global $DIC;
 
        $this->lm = $object;
        $this->ctrl = $DIC->ctrl();
        $this->mainTemplate = $DIC->ui()->mainTemplate();
        $this->uiFactory = $DIC->ui()->factory();
        $this->uiRenderer = $DIC->ui()->renderer();
        $this->httpRequest = $DIC->http()->request();
        $this->tabs = $DIC->tabs();
        $this->user = $DIC->user();
    }

References $DIC, and user().

Here is the call graph for this function:

toggleLearningProgress()

ilLearningModuleKioskModeView::toggleLearningProgress ( string  $command )

protected

Parameters

string

$command

Definition at line 246 of file class.ilLearningModuleKioskModeView.php.

    {
        if (self::CMD_TOGGLE_LEARNING_PROGRESS === $command) {
            $learningProgress = \ilObjectLP::getInstance($this->lm->getId());
            if ($learningProgress->getCurrentMode() == \ilLPObjSettings::LP_MODE_MANUAL) {
                $marks = new \ilLPMarks($this->lm->getId(), $this->user->getId());
                $marks->setCompleted(!$marks->getCompleted());
                $marks->update();
 
                \ilLPStatusWrapper::_updateStatus($this->lm->getId(), $this->user->getId());
 
                $this->lng->loadLanguageModule('trac');
                $this->messages[] = $this->uiFactory->messageBox()->success(
                    $this->lng->txt('trac_updated_status')
                );
            }
        }
    }

References ilLPStatusWrapper\_updateStatus(), ilObjectLP\getInstance(), and ilLPObjSettings\LP_MODE_MANUAL.

Referenced by updateGet().

Here is the call graph for this function:

Here is the caller graph for this function:

updateGet()

ilLearningModuleKioskModeView::updateGet	(	State	$state,
		string	$command,
		int	$param = null
	)

@inheritDoc

Implements ILIAS\KioskMode\View.

Definition at line 96 of file class.ilLearningModuleKioskModeView.php.

                                                                                : State
    {
        switch ($command) {
            case "layout":
                if ($param > 0) {
                    $this->current_page_id = $param;
                    $state = $state->withValueFor("current_page", (string) $this->current_page_id);
                }
                break;
            case self::CMD_TOGGLE_LEARNING_PROGRESS:
                $this->toggleLearningProgress($command);
                break;
        }
 
        //$this->initLMService($this->current_page_id);
 
        return $state;
    }

References $param, CMD_TOGGLE_LEARNING_PROGRESS, toggleLearningProgress(), and ILIAS\KioskMode\State\withValueFor().

Here is the call graph for this function:

updatePost()

ilLearningModuleKioskModeView::updatePost	(	State	$state,
		string	$command,
		array	$post
	)

@inheritDoc

Implements ILIAS\KioskMode\View.

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

                                                                           : State
    {
        return $state;
    }

Field Documentation

$additional_content

ilLearningModuleKioskModeView::$additional_content = []

protected

Definition at line 66 of file class.ilLearningModuleKioskModeView.php.

Referenced by render().

$ctrl

ilLearningModuleKioskModeView::$ctrl

protected

Definition at line 49 of file class.ilLearningModuleKioskModeView.php.

$current_page_id

ilLearningModuleKioskModeView::$current_page_id = 0

protected

Definition at line 63 of file class.ilLearningModuleKioskModeView.php.

$httpRequest

ilLearningModuleKioskModeView::$httpRequest

protected

Definition at line 55 of file class.ilLearningModuleKioskModeView.php.

$lm

ilLearningModuleKioskModeView::$lm

protected

Definition at line 28 of file class.ilLearningModuleKioskModeView.php.

$lm_pres

ilLearningModuleKioskModeView::$lm_pres

protected

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

$lm_pres_service

ilLearningModuleKioskModeView::$lm_pres_service

protected

Definition at line 33 of file class.ilLearningModuleKioskModeView.php.

$mainTemplate

ilLearningModuleKioskModeView::$mainTemplate

protected

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

$menu_entries

ilLearningModuleKioskModeView::$menu_entries = null

protected

Definition at line 25 of file class.ilLearningModuleKioskModeView.php.

Referenced by getMenuEntries().

$messages

ilLearningModuleKioskModeView::$messages = []

protected

Definition at line 61 of file class.ilLearningModuleKioskModeView.php.

$tabs

ilLearningModuleKioskModeView::$tabs

protected

Definition at line 58 of file class.ilLearningModuleKioskModeView.php.

$uiFactory

ilLearningModuleKioskModeView::$uiFactory

protected

Definition at line 43 of file class.ilLearningModuleKioskModeView.php.

$uiRenderer

ilLearningModuleKioskModeView::$uiRenderer

protected

Definition at line 46 of file class.ilLearningModuleKioskModeView.php.

$user

ilLearningModuleKioskModeView::$user

protected

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

CMD_TOGGLE_LEARNING_PROGRESS

const ilLearningModuleKioskModeView::CMD_TOGGLE_LEARNING_PROGRESS = 'toggleManualLearningProgress'

Definition at line 21 of file class.ilLearningModuleKioskModeView.php.

Referenced by updateGet().

---

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

• Modules/LearningModule/classes/class.ilLearningModuleKioskModeView.php