ilLearningModuleKioskModeView Class Reference

Class ilLearningModuleKioskModeView. More...

Inheritance diagram for ilLearningModuleKioskModeView:

Collaboration diagram for ilLearningModuleKioskModeView:

Public Member Functions
	updateGet (State $state, string $command, ?int $parameter=null)
	Update the state based on the provided command. More...
	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...
	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, Factory $factory, URLBuilder $url_builder, ?array $post=null)
Public Member Functions inherited from ilKioskModeView
	__construct (ilObject $object, ilCtrl $ctrl, ilLanguage $lng, ilAccessHandler $access)
Public Member Functions inherited from ILIAS\KioskMode\View
	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 ()
	initLMService (?int $current_page)
	hasPermissionToAccessKioskMode ()
	getMenuEntries ()
	maybeBuildLearningProgressToggleControl (ControlBuilder $builder)
	toggleLearningProgress (string $command)
Protected Member Functions inherited from ilKioskModeView
	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
ilPageObject	$contentPageObject
ilObjLearningModule	$lm
ilLMPresentationService	$lm_pres_service
ilLMPresentationGUI	$lm_pres = null
ilObjUser	$user
Factory	$uiFactory
Renderer	$uiRenderer
ilGlobalTemplateInterface	$mainTemplate
ServerRequestInterface	$httpRequest
ilTabsGUI	$tabs
array	$messages = []
int	$current_page_id = 0
array	$additional_content = []
array	$menu_entries = null
Protected Attributes inherited from ilKioskModeView
ilCtrl	$ctrl
ilLanguage	$lng
ilAccessHandler	$access

Detailed Description

Class ilLearningModuleKioskModeView.

Author

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

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

Member Function Documentation

buildControls()

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

Construct the controls for the view based on the current state.

The interaction with the controls build via the ControlBuilder will always be delegated to updateGet.

Implements ILIAS\KioskMode\View.

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

References $DIC, ILIAS\KioskMode\ControlBuilder\genericWithSignal(), getMenuEntries(), ILIAS\KioskMode\State\getValueFor(), initLMService(), maybeBuildLearningProgressToggleControl(), ILIAS\KioskMode\ControlBuilder\next(), ILIAS\KioskMode\ControlBuilder\previous(), and ILIAS\KioskMode\ControlBuilder\tableOfContent().

     : ControlBuilder {
        global $DIC;

        $main_tpl = $DIC->ui()->mainTemplate();

        // this may be necessary if updateGet has not been processed

        // THIS currently fails
        $this->initLMService((int) $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);

        // 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;
    }

Here is the call graph for this function:

buildInitialState()

ilLearningModuleKioskModeView::buildInitialState

(

State

$empty_state

)

Build an initial state based on the Provided empty state.

Implements ILIAS\KioskMode\View.

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

References ILIAS\KioskMode\State\withValueFor().

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

Here is the call graph for this function:

getMenuEntries()

ilLearningModuleKioskModeView::getMenuEntries ( )

protected

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

References $menu_entries.

Referenced by buildControls(), and render().

                                       : 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;
    }

Here is the caller graph for this function:

getObjectClass()

ilLearningModuleKioskModeView::getObjectClass ( )

protected

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

References $DIC, ILIAS\Repository\ctrl(), mainTemplate(), ilKioskModeView\setObject(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

                                       : string
    {
        return \ilObjLearningModule::class;
    }

Here is the call graph for this function:

hasPermissionToAccessKioskMode()

ilLearningModuleKioskModeView::hasPermissionToAccessKioskMode ( )

protected

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

References ILIAS\Repository\access().

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

Here is the call graph for this function:

initLMService()

ilLearningModuleKioskModeView::initLMService ( ?int  $current_page )

protected

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

References ILIAS\Repository\int().

Referenced by buildControls(), and render().

                                                        : void
    {
        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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

maybeBuildLearningProgressToggleControl()

ilLearningModuleKioskModeView::maybeBuildLearningProgressToggleControl ( ControlBuilder  $builder )

protected

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

References ilLPMarks\_hasCompleted(), ILIAS\KioskMode\ControlBuilder\generic(), ilObjectLP\getInstance(), ILIAS\Repository\lng(), ilLPObjSettings\LP_MODE_MANUAL, and ILIAS\Repository\user().

Referenced by buildControls().

     : 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;
    }

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
	)

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

References ILIAS\Repository\ctrl(), getMenuEntries(), ILIAS\KioskMode\State\getValueFor(), initLMService(), and ILIAS\UI\Factory\legacy().

     : Component {
        $this->initLMService((int) $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($content);
    }

Here is the call graph for this function:

toggleLearningProgress()

ilLearningModuleKioskModeView::toggleLearningProgress ( string  $command )

protected

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

References ilLPStatusWrapper\_updateStatus(), ilObjectLP\getInstance(), ILIAS\Repository\lng(), ilLPObjSettings\LP_MODE_MANUAL, and ILIAS\Repository\user().

Referenced by updateGet().

     : void {
        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')
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateGet()

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

Update the state based on the provided command.

If the update was caused by a control with a $parameter (see ControlBuilder) that value is passed to $parameter here.

Commands and parameters are defined by the view in buildControl.

Implements ILIAS\KioskMode\View.

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

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

     : State {
        switch ($command) {
            case "layout":
                if ($parameter > 0) {
                    $this->current_page_id = $parameter;
                    $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;
    }

Here is the call graph for this function:

updatePost()

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

Update the state and the object based on the provided command and post-data.

Commands are defined via the url-builder provided to render.

The POSTed data will be passed via $post.

Implements ILIAS\KioskMode\View.

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

     : State {
        return $state;
    }

Field Documentation

$additional_content

array ilLearningModuleKioskModeView::$additional_content = []

protected

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

$contentPageObject

ilPageObject ilLearningModuleKioskModeView::$contentPageObject

protected

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

$current_page_id

int ilLearningModuleKioskModeView::$current_page_id = 0

protected

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

$httpRequest

ServerRequestInterface ilLearningModuleKioskModeView::$httpRequest

protected

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

$lm

ilObjLearningModule ilLearningModuleKioskModeView::$lm

protected

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

$lm_pres

ilLMPresentationGUI ilLearningModuleKioskModeView::$lm_pres = null

protected

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

$lm_pres_service

ilLMPresentationService ilLearningModuleKioskModeView::$lm_pres_service

protected

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

$mainTemplate

ilGlobalTemplateInterface ilLearningModuleKioskModeView::$mainTemplate

protected

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

$menu_entries

array ilLearningModuleKioskModeView::$menu_entries = null

protected

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

Referenced by getMenuEntries().

$messages

array ilLearningModuleKioskModeView::$messages = []

protected

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

$tabs

ilTabsGUI ilLearningModuleKioskModeView::$tabs

protected

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

$uiFactory

Factory ilLearningModuleKioskModeView::$uiFactory

protected

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

$uiRenderer

Renderer ilLearningModuleKioskModeView::$uiRenderer

protected

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

$user

ilObjUser ilLearningModuleKioskModeView::$user

protected

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

CMD_TOGGLE_LEARNING_PROGRESS

const ilLearningModuleKioskModeView::CMD_TOGGLE_LEARNING_PROGRESS = 'toggleManualLearningProgress'

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

---

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

• components/ILIAS/LearningModule/classes/class.ilLearningModuleKioskModeView.php