ilFileKioskModeView Class Reference

Inheritance diagram for ilFileKioskModeView:

Collaboration diagram for ilFileKioskModeView:

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
	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 ()
	hasPermissionToAccessKioskMode ()
	buildLearningProgressToggleControl (ControlBuilder $builder)
	toggleLearningProgress ()
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
ilObjFile	$file_obj
ilObjUser	$user
Factory	$ui_factory
Renderer	$ui_renderer
ilGlobalTemplateInterface	$main_template
GlobalHttpState	$http
Refinery	$refinery
ilTabsGUI	$tabs
array	$messages = []
Protected Attributes inherited from ilKioskModeView
ilCtrl	$ctrl
ilLanguage	$lng
ilAccessHandler	$access

Private Attributes
const	CMD_TOGGLE_LEARNING_PROGRESS = 'toggleManualLearningProgress'

Detailed Description

Author

Lukas Zehnder lukas.nosp@m.@sr..nosp@m.solut.nosp@m.ions

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

Member Function Documentation

buildControls()

ilFileKioskModeView::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 84 of file class.ilFileKioskModeView.php.

References $learning_progress, buildLearningProgressToggleControl(), ilObjectLP\getInstance(), and ilLPObjSettings\LP_MODE_MANUAL.

                                                                        : void
    {
        $learning_progress = \ilObjectLP::getInstance($this->file_obj->getId());
        if ($learning_progress->getCurrentMode(
        ) === \ilLPObjSettings::LP_MODE_MANUAL) { //TODO: create and implement handling for second lp mode
            $this->buildLearningProgressToggleControl($builder);
        }
    }

Here is the call graph for this function:

buildInitialState()

ilFileKioskModeView::buildInitialState

(

State

$empty_state

)

Build an initial state based on the Provided empty state.

Implements ILIAS\KioskMode\View.

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

                                                         : State
    {
        return $empty_state;
    }

buildLearningProgressToggleControl()

ilFileKioskModeView::buildLearningProgressToggleControl ( ControlBuilder  $builder )

protected

Definition at line 112 of file class.ilFileKioskModeView.php.

References ilLPStatus\_hasUserCompleted(), ILIAS\KioskMode\ControlBuilder\generic(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by buildControls().

                                                                                  : ControlBuilder
    {
        $this->lng->loadLanguageModule('file');
        if (ilLPStatus::_hasUserCompleted($this->file_obj->getId(), $this->user->getId())) {
            $learning_progress_toggle_ctrl_label = $this->lng->txt('file_btn_lp_toggle_state_completed');
        } else {
            $learning_progress_toggle_ctrl_label = $this->lng->txt('file_btn_lp_toggle_state_not_completed');
        }

        return $builder->generic(
            $learning_progress_toggle_ctrl_label,
            self::CMD_TOGGLE_LEARNING_PROGRESS,
            1
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectClass()

ilFileKioskModeView::getObjectClass ( )

protected

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

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

                                       : string
    {
        return ilObjFile::class;
    }

Here is the call graph for this function:

hasPermissionToAccessKioskMode()

ilFileKioskModeView::hasPermissionToAccessKioskMode ( )

protected

Definition at line 74 of file class.ilFileKioskModeView.php.

References ILIAS\Repository\access().

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

Here is the call graph for this function:

render()

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

Definition at line 106 of file class.ilFileKioskModeView.php.

References ILIAS\UI\Factory\legacy().

                                                                                                        : Component
    {
        $file_gui = new ilObjFileGUI($this->file_obj->getRefId());
        return $factory->legacy()->content($file_gui->buildInfoScreen(true)->getHTML());
    }

Here is the call graph for this function:

toggleLearningProgress()

ilFileKioskModeView::toggleLearningProgress ( )

protected

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

References ilLPStatus\_hasUserCompleted(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ILIAS\Repository\user(), and ilLPStatus\writeStatus().

Referenced by updateGet().

                                               : void
    {
        if (!ilLPStatus::_hasUserCompleted($this->file_obj->getId(), $this->user->getId())) {
            ilLPStatus::writeStatus(
                $this->file_obj->getId(),
                $this->user->getId(),
                ilLPStatus::LP_STATUS_COMPLETED_NUM
            );
        } else {
            ilLPStatus::writeStatus(
                $this->file_obj->getId(),
                $this->user->getId(),
                ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateGet()

ilFileKioskModeView::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 93 of file class.ilFileKioskModeView.php.

References toggleLearningProgress().

                                                                                    : State
    {
        if ($command === self::CMD_TOGGLE_LEARNING_PROGRESS) {
            $this->toggleLearningProgress();
        }
        return $state;
    }

Here is the call graph for this function:

updatePost()

ilFileKioskModeView::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 101 of file class.ilFileKioskModeView.php.

                                                                          : State
    {
        return $state;
    }

Field Documentation

$file_obj

ilObjFile ilFileKioskModeView::$file_obj

protected

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

$http

GlobalHttpState ilFileKioskModeView::$http

protected

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

$main_template

ilGlobalTemplateInterface ilFileKioskModeView::$main_template

protected

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

$messages

array ilFileKioskModeView::$messages = []

protected

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

$refinery

Refinery ilFileKioskModeView::$refinery

protected

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

$tabs

ilTabsGUI ilFileKioskModeView::$tabs

protected

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

$ui_factory

Factory ilFileKioskModeView::$ui_factory

protected

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

$ui_renderer

Renderer ilFileKioskModeView::$ui_renderer

protected

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

$user

ilObjUser ilFileKioskModeView::$user

protected

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

CMD_TOGGLE_LEARNING_PROGRESS

const ilFileKioskModeView::CMD_TOGGLE_LEARNING_PROGRESS = 'toggleManualLearningProgress'

private

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

---

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

• components/ILIAS/File/classes/class.ilFileKioskModeView.php