Class ilContentPageKioskModeView. More...

Inheritance diagram for ilContentPageKioskModeView:

Collaboration diagram for ilContentPageKioskModeView:

Public Member Functions
	buildInitialState (State $empty_state)
	@inheritDoc More...

	buildControls (State $state, ControlBuilder $builder)
	@inheritDoc More...

	updateGet (State $state, string $command, int $param=null)
	@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_LP_TO_COMPLETED = 'lp_completed'

const	CMD_LP_TO_INCOMPLETE = 'lp_incomplete'

Protected Member Functions
	getObjectClass ()
	@inheritDoc More...

	setObject (ilObject $object)
	@inheritDoc More...

	hasPermissionToAccessKioskMode ()
	@inheritDoc More...

	buildLearningProgressToggleControl (ControlBuilder $builder)

	toggleLearningProgress (string $command)

	renderContentStyle ()
	Renders the content style of a ContentPage object into main template. More...

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
	$contentPageObject

	$user

	$uiFactory

	$uiRenderer

	$ctrl

	$mainTemplate

	$httpRequest

	$tabs

	$messages = []

Protected Attributes inherited from ilKioskModeView
	$ctrl

	$lng

	$access

Detailed Description

Class ilContentPageKioskModeView.

Definition at line 16 of file class.ilContentPageKioskModeView.php.

Member Function Documentation

◆ buildControls()

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

@inheritDoc

Implements ILIAS\KioskMode\View.

Definition at line 85 of file class.ilContentPageKioskModeView.php.

    {
        $this->buildLearningProgressToggleControl($builder);
    }

References buildLearningProgressToggleControl().

Here is the call graph for this function:

◆ buildInitialState()

ilContentPageKioskModeView::buildInitialState ( State $empty_state )

@inheritDoc

Implements ILIAS\KioskMode\View.

Definition at line 77 of file class.ilContentPageKioskModeView.php.

                                                          : State
    {
        return $empty_state;
    }

◆ buildLearningProgressToggleControl()

ilContentPageKioskModeView::buildLearningProgressToggleControl ( ControlBuilder $builder )

protected

Parameters

ControlBuilder $builder

Definition at line 93 of file class.ilContentPageKioskModeView.php.

                                                                                   : void
    {
        $learningProgress = ilObjectLP::getInstance($this->contentPageObject->getId());
        if ($learningProgress->getCurrentMode() == ilLPObjSettings::LP_MODE_MANUAL) {
            $isCompleted = ilLPMarks::_hasCompleted($this->user->getId(), $this->contentPageObject->getId());
 
            $this->lng->loadLanguageModule('copa');
            $learningProgressToggleCtrlLabel = $this->lng->txt('copa_btn_lp_toggle_state_completed');
            $cmd = self::CMD_LP_TO_INCOMPLETE;
            if (!$isCompleted) {
                $learningProgressToggleCtrlLabel = $this->lng->txt('copa_btn_lp_toggle_state_not_completed');
                $cmd = self::CMD_LP_TO_COMPLETED;
            }
 
            $builder->generic(
                $learningProgressToggleCtrlLabel,
                $cmd,
                1
            );
        }
    }

References $builder, ilLPMarks\_hasCompleted(), CMD_LP_TO_COMPLETED, CMD_LP_TO_INCOMPLETE, 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:

◆ getObjectClass()

ilContentPageKioskModeView::getObjectClass ( )

protected

@inheritDoc

Reimplemented from ilKioskModeView.

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

                                        : string
    {
        return ilObjContentPage::class;
    }

◆ hasPermissionToAccessKioskMode()

ilContentPageKioskModeView::hasPermissionToAccessKioskMode ( )

protected

@inheritDoc

Reimplemented from ilKioskModeView.

Definition at line 69 of file class.ilContentPageKioskModeView.php.

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

◆ render()

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

@inheritDoc

Definition at line 165 of file class.ilContentPageKioskModeView.php.

      : Component {
        ilLearningProgress::_tracProgress(
            $this->user->getId(),
            $this->contentPageObject->getId(),
            $this->contentPageObject->getRefId(),
            $this->contentPageObject->getType()
        );
 
        $this->renderContentStyle();
 
        $forwarder = new ilContentPagePageCommandForwarder(
            $this->httpRequest,
            $this->ctrl,
            $this->tabs,
            $this->lng,
            $this->contentPageObject,
            $this->user
        );
        $forwarder->setPresentationMode(ilContentPagePageCommandForwarder::PRESENTATION_MODE_EMBEDDED_PRESENTATION);
 
        $this->ctrl->setParameterByClass(ilContentPagePageGUI::class, 'ref_id', $this->contentPageObject->getRefId());
 
        return $factory->legacy(implode('', [
            $this->uiRenderer->render($this->messages),
            $forwarder->forward($this->ctrl->getLinkTargetByClass([
                ilRepositoryGUI::class, ilObjContentPageGUI::class, ilContentPagePageGUI::class
            ]))
        ]));
    }

◆ renderContentStyle()

ilContentPageKioskModeView::renderContentStyle ( )

protected

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

Definition at line 203 of file class.ilContentPageKioskModeView.php.

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

ilContentPageKioskModeView::setObject ( ilObject $object )

protected

@inheritDoc

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

    {
        global $DIC;
 
        $this->contentPageObject = $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()

ilContentPageKioskModeView::toggleLearningProgress ( string $command )

protected

Parameters

string $command

Definition at line 128 of file class.ilContentPageKioskModeView.php.

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

References ilLPStatusWrapper\_updateStatus(), CMD_LP_TO_COMPLETED, 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()

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

@inheritDoc

Implements ILIAS\KioskMode\View.

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

                                                                                : State
    {
        $this->toggleLearningProgress($command);
 
        return $state;
    }

References toggleLearningProgress().

Here is the call graph for this function:

◆ updatePost()

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

@inheritDoc

Implements ILIAS\KioskMode\View.

Definition at line 157 of file class.ilContentPageKioskModeView.php.

                                                                           : State
    {
        return $state;
    }

Field Documentation

◆ $contentPageObject

ilContentPageKioskModeView::$contentPageObject

protected

Definition at line 22 of file class.ilContentPageKioskModeView.php.

◆ $ctrl

ilContentPageKioskModeView::$ctrl

protected

Definition at line 30 of file class.ilContentPageKioskModeView.php.

◆ $httpRequest

ilContentPageKioskModeView::$httpRequest

protected

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

◆ $mainTemplate

ilContentPageKioskModeView::$mainTemplate

protected

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

◆ $messages

ilContentPageKioskModeView::$messages = []

protected

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

◆ $tabs

ilContentPageKioskModeView::$tabs

protected

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

◆ $uiFactory

ilContentPageKioskModeView::$uiFactory

protected

Definition at line 26 of file class.ilContentPageKioskModeView.php.

◆ $uiRenderer

ilContentPageKioskModeView::$uiRenderer

protected

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

◆ $user

ilContentPageKioskModeView::$user

protected

Definition at line 24 of file class.ilContentPageKioskModeView.php.

◆ CMD_LP_TO_COMPLETED

const ilContentPageKioskModeView::CMD_LP_TO_COMPLETED = 'lp_completed'

Definition at line 18 of file class.ilContentPageKioskModeView.php.

Referenced by buildLearningProgressToggleControl(), and toggleLearningProgress().

◆ CMD_LP_TO_INCOMPLETE

const ilContentPageKioskModeView::CMD_LP_TO_INCOMPLETE = 'lp_incomplete'

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

Referenced by buildLearningProgressToggleControl().

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

Modules/ContentPage/classes/class.ilContentPageKioskModeView.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ buildControls()

◆ buildInitialState()

◆ buildLearningProgressToggleControl()

◆ getObjectClass()

◆ hasPermissionToAccessKioskMode()

◆ render()

◆ renderContentStyle()

◆ setObject()

◆ toggleLearningProgress()

◆ updateGet()

◆ updatePost()

Field Documentation

◆ $contentPageObject

◆ $ctrl

◆ $httpRequest

◆ $mainTemplate

◆ $messages

◆ $tabs

◆ $uiFactory

◆ $uiRenderer

◆ $user

◆ CMD_LP_TO_COMPLETED

◆ CMD_LP_TO_INCOMPLETE