ilContentPageKioskModeView Class Reference

Inheritance diagram for ilContentPageKioskModeView:

Collaboration diagram for ilContentPageKioskModeView:

Public Member Functions
	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, 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
	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...

Protected Member Functions
	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...
	buildLearningProgressToggleControl (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
ilObjContentPage	$contentPageObject
ilObjUser	$user
Factory	$uiFactory
Renderer	$uiRenderer
ilGlobalTemplateInterface	$mainTemplate
GlobalHttpState	$http
Refinery	$refinery
ilTabsGUI	$tabs
array	$messages = []
ILIAS Style Content Object ObjectFacade	$content_style_domain
ILIAS Style Content GUIService	$content_style_gui
Protected Attributes inherited from ilKioskModeView
ilCtrl	$ctrl
ilLanguage	$lng
ilAccessHandler	$access

Private Attributes
const	CMD_LP_TO_COMPLETED = 'lp_completed'
const	CMD_LP_TO_INCOMPLETE = 'lp_incomplete'

Detailed Description

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

Member Function Documentation

buildControls()

ilContentPageKioskModeView::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 83 of file class.ilContentPageKioskModeView.php.

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

References buildLearningProgressToggleControl().

Here is the call graph for this function:

buildInitialState()

ilContentPageKioskModeView::buildInitialState

(

State

$empty_state

)

Build an initial state based on the Provided empty state.

Implements ILIAS\KioskMode\View.

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

                                                         : State
    {
        return $empty_state;
    }

buildLearningProgressToggleControl()

ilContentPageKioskModeView::buildLearningProgressToggleControl ( ControlBuilder  $builder )

protected

Definition at line 88 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 ilLPMarks\_hasCompleted(), CMD_LP_TO_COMPLETED, CMD_LP_TO_INCOMPLETE, ILIAS\KioskMode\ControlBuilder\generic(), ilObjectLP\getInstance(), ILIAS\Repository\lng(), ilLPObjSettings\LP_MODE_MANUAL, and ILIAS\Repository\user().

Referenced by buildControls().

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectClass()

ilContentPageKioskModeView::getObjectClass ( )

protected

Get the class of objects this view displays.

Reimplemented from ilKioskModeView.

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

                                       : string
    {
        return ilObjContentPage::class;
    }

hasPermissionToAccessKioskMode()

ilContentPageKioskModeView::hasPermissionToAccessKioskMode ( )

protected

Check if the global user has permission to access the kiosk mode of the supplied object.

Reimplemented from ilKioskModeView.

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

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

References ILIAS\Repository\access().

Here is the call graph for this function:

render()

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

Definition at line 148 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->http,
            $this->ctrl,
            $this->tabs,
            $this->lng,
            $this->contentPageObject,
            $this->user,
            $this->refinery,
            $this->content_style_domain
        );
        $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 188 of file class.ilContentPageKioskModeView.php.

                                           : void
    {
        $this->mainTemplate->addCss(ilObjStyleSheet::getSyntaxStylePath());
        $this->content_style_gui->addCss(
            $this->mainTemplate,
            $this->contentPageObject->getRefId()
        );
    }

References ilObjStyleSheet\getSyntaxStylePath(), and ILIAS\Repository\mainTemplate().

Here is the call graph for this function:

setObject()

ilContentPageKioskModeView::setObject ( ilObject  $object )

protected

Set the object for this view.

This makes it possible to use an appropriately typehinted member variable to allow for static code analysis. Sadly PHP has no generics...

Reimplemented from ilKioskModeView.

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

                                                  : void
    {
        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->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->tabs = $DIC->tabs();
        $this->user = $DIC->user();
        $cs = $DIC->contentStyle();
        $this->content_style_gui = $cs->gui();
        $this->content_style_domain = $cs->domain()->styleForRefId($object->getRefId());
    }

References $DIC, ILIAS\Repository\ctrl(), ilObject\getRefId(), ILIAS\FileDelivery\http(), ILIAS\Repository\mainTemplate(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

toggleLearningProgress()

ilContentPageKioskModeView::toggleLearningProgress ( string  $command )

protected

Definition at line 117 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 ((int) $old_state !== (int) $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(), ILIAS\Repository\lng(), 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	$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 110 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
	)

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 143 of file class.ilContentPageKioskModeView.php.

                                                                          : State
    {
        return $state;
    }

Field Documentation

$content_style_domain

ILIAS Style Content Object ObjectFacade ilContentPageKioskModeView::$content_style_domain

protected

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

$content_style_gui

ILIAS Style Content GUIService ilContentPageKioskModeView::$content_style_gui

protected

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

$contentPageObject

ilObjContentPage ilContentPageKioskModeView::$contentPageObject

protected

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

$http

GlobalHttpState ilContentPageKioskModeView::$http

protected

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

$mainTemplate

ilGlobalTemplateInterface ilContentPageKioskModeView::$mainTemplate

protected

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

$messages

array ilContentPageKioskModeView::$messages = []

protected

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

$refinery

Refinery ilContentPageKioskModeView::$refinery

protected

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

$tabs

ilTabsGUI ilContentPageKioskModeView::$tabs

protected

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

$uiFactory

Factory ilContentPageKioskModeView::$uiFactory

protected

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

$uiRenderer

Renderer ilContentPageKioskModeView::$uiRenderer

protected

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

$user

ilObjUser ilContentPageKioskModeView::$user

protected

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

CMD_LP_TO_COMPLETED

const ilContentPageKioskModeView::CMD_LP_TO_COMPLETED = 'lp_completed'

private

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

Referenced by buildLearningProgressToggleControl(), and toggleLearningProgress().

CMD_LP_TO_INCOMPLETE

const ilContentPageKioskModeView::CMD_LP_TO_INCOMPLETE = 'lp_incomplete'

private

Definition at line 34 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